Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AsposeOmrDeveloper committed Jul 5, 2018
1 parent 3422745 commit 86a5232
Showing 1 changed file with 16 additions and 34 deletions.
50 changes: 16 additions & 34 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# asposeomrcloud
# Aspose.OMR for Cloud

>Aspose.OMR for Cloud is a REST API that helps you to perform optical mark recognition in the cloud. You can get binaries to start working immediately and recognize various OMR forms. Developers can embed optical 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 in your project.
[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.

## Quickstart

You can perform tasks out of the box without writing a single line of code with our [GUI client](https://github.com/aspose-omr-cloud/aspose-omr-cloud-dotnet/releases). You can also refer to the [client documentation](https://docs.aspose.cloud/display/omrcloud/Aspose.OMR.Client+Application).

## Requirements.

NodeJS v4 or v8
NodeJS v4+

## Installation

Expand All @@ -13,39 +19,16 @@ You need to clone `asposeomrcloud` and run
```sh
npm install && npm run-script build
```
## Optional requirements

## Usage
```javascript
api = require('<path to asposeomrcloud>');
```
## Getting Started

Please follow the [installation](#installation) instruction and execute the following JavaScript code:

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

api = require('.');

// You can acquire App SID and App Key by registrating at Aspose Cloud Dashboard https://dashboard.aspose.cloud
APP_KEY = 'xxxxx'
APP_SID = 'xxxxx'

omrApi = new api.OmrApi(APP_SID, APP_KEY, 'https://api.aspose.cloud/v1.1');
param = new api.OMRFunctionParam();
param.functionParam = JSON.stringify({'ExtraStoragePath' : 'Logos'});
omrApi.postRunOmrTask('Aspose_test.txt', "GenerateTemplate", param)
.then(() => console.log('OK'))
.catch((error) => {
if (typeof error === 'string')
console.log("ERROR " + error);
else if (typeof error === 'object') {
console.log("ERROR : Status Code " + error.response.statusCode);
console.log("ERROR : Error Message " + error.response.body);
}
});

```
## 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.

## Authorization

Expand All @@ -55,4 +38,3 @@ Library uses OAUTH2 internally

Aspose Pty Ltd (https://www.aspose.com)


0 comments on commit 86a5232

Please sign in to comment.