Skip to content

Commit

Permalink
Update package.json and readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
AsposeOmrDeveloper committed Sep 11, 2018
1 parent ccd171a commit 67d67af
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 15 deletions.
2 changes: 1 addition & 1 deletion demo/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "asposeomrcloud-demo",
"version": "1.0.0",
"description": "Demo for NodeJS client for asposeomrcloud",
"description": "Demo for NodeJS client for aspose-omr-cloud",
"repository": "aspose-omr-cloud/aspose-omr-cloud-nodejs",
"scripts": {
"demo": "node demo.js"
Expand Down
30 changes: 20 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,26 +1,36 @@
{
"name": "asposeomrcloud",
"version": "1.0.0",
"description": "NodeJS client for asposeomrcloud",
"name": "aspose-omr-cloud",
"version": "18.8.0",
"description": "Node.Js library for communicating with the Aspose.OMR Cloud API",
"homepage": "https://products.aspose.cloud/omr/nodejs",
"repository": "aspose-omr-cloud/aspose-omr-cloud-nodejs",
"author": "Aspose Pty Ltd",
"license": "MIT",
"readmeFilename": "README.md",
"engines": {
"node": ">=4.0"
},
"keywords": [
"Aspose",
"Cloud",
"OMR"
],
"main": "lib/asposeomrcloud/api.js",
"types": "lib/asposeomrcloud/api.d.ts",
"scripts": {
"clean": "shx rm -Rf *.js",
"build": "tsc",
"demo": "npm run build && pushd demo && npm install && npm run-script demo && popd"
},
"author": "Aspose Pty Ltd",
"bugs": {
"bugs": {
"url": "https://github.com/aspose-omr-cloud/aspose-omr-cloud-nodejs/issues"
},
"homepage": "https://github.com/aspose-omr-cloud/aspose-omr-cloud-nodejs#readme",
"license": "MIT",
"dependencies": {
"bluebird": "^3.5.0",
"request": "^2.81.0",
"@types/bluebird": "*",
"@types/request": "*"
"@types/request": "*",
"asposestoragecloud": "^1.0.5",
"bluebird": "^3.5.0",
"request": "^2.81.0"
},
"devDependencies": {
"typescript": "^2.4.2",
Expand Down
9 changes: 5 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

[Aspose.OMR for Cloud](https://products.aspose.cloud/omr/cloud) is a REST API that helps you to perform optical mark recognition in the cloud. We provide a series of [SDKs](https://github.com/aspose-omr-cloud). Along with that, you can get [binaries](https://github.com/aspose-omr-cloud/aspose-omr-cloud-dotnet/releases) to start working immediately and recognize various OMR forms.

Developers can embed [optical recognition](https://en.wikipedia.org/wiki/Optical_mark_recognition) in any type of application to extract data from images of tests, exams, questionnaires, surveys, etc. In the repository you can find examples on how to start using [Aspose.OMR API ](https://docs.aspose.cloud/display/omrcloud/OMR+API+Specification)in your project.
Developers can embed [optical recognition](https://en.wikipedia.org/wiki/Optical_mark_recognition) in any type of application to extract data from images of tests, exams, questionnaires, surveys, etc. In the repository you can find examples on how to start using [Aspose.OMR API](https://docs.aspose.cloud/display/omrcloud/OMR+API+Specification) in your project.


## Quickstart

Expand All @@ -14,21 +15,21 @@ NodeJS v4+

## Installation

You need to clone `asposeomrcloud` and run
You need to clone `aspose-omr-cloud` and run

```sh
npm install && npm run-script build
```
## Optional requirements

To take full advantage of Aspose.OMR for Cloud, _asposestoragecloud_ is required. Just run `npm install Aasposestoragecloud`.
To take full advantage of Aspose.OMR for Cloud, _asposestoragecloud_ is required. Just run `npm install asposestoragecloud`.

## Usage
### Receive Cloud Keys
Aspose.Cloud credentials are required to use Aspose.OMR for Cloud API. You can acquire App SID and App Key by registrating at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud). It will take only a couple of minutes.

### Code example
You can check out [OMR Demo](https://github.com/aspose-omr-cloud/aspose-omr-cloud-nodejs/tree/master/demo) project to get started with Aspose.OMR for Cloud.
You can check out [OMR Demo](demo) project to get started with Aspose.OMR for Cloud.

## Authorization

Expand Down

0 comments on commit 67d67af

Please sign in to comment.