Skip to content

Commit 08fd6d2

Browse files
authored
Standardized readme.md
1 parent a3afe22 commit 08fd6d2

File tree

1 file changed

+35
-25
lines changed

1 file changed

+35
-25
lines changed

README.md

Lines changed: 35 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,37 @@
1-
# Aspose.Tasks Cloud
2-
[Aspose.Tasks Cloud](https://products.aspose.cloud/tasks/cloud)
1+
![](https://img.shields.io/badge/api-v3.0-lightgrey) ![npm (scoped)](https://img.shields.io/npm/v/@asposecloud/aspose-tasks-cloud) ![npm bundle size](https://img.shields.io/bundlephobia/min/@asposecloud/aspose-tasks-cloud) ![node-current](https://img.shields.io/node/v/@asposecloud/aspose-tasks-cloud) [![GitHub license](https://img.shields.io/github/license/aspose-tasks-cloud/aspose-tasks-cloud-node)](LICENSE) ![GitHub last commit](https://img.shields.io/github/last-commit/Aspose-tasks-Cloud/aspose-tasks-cloud-node)
32

4-
Aspose.Tasks Cloud is a REST API for manipulating and converting Microsoft Project documents hosted on cloud platforms. It allows you to work with all aspects of a Project document as well as offers a wide range of export options allowing developers to convert Microsoft Project documents a number of industry standard formats. Our Cloud SDKs are wrappers around REST API in various programming languages, allowing you to work with Project documents in language of your choice quickly and easily, gaining all benefits of strong types and IDE highlights.
3+
# Node.js SDK to Manage Tasks in the Cloud
54

6-
This repository contains Aspose.Tasks Cloud SDK for Node.js source code. This SDK allows you to work with Aspose.Tasks Cloud REST APIs in your nodejs applications quickly and easily, with zero initial cost.
5+
Aspose.Tasks for Cloud offers the ability to manipulate and convert Microsoft Project MPT, MPP, MPX & Oracle Primavera XER, XML, and PrimaveraP6XML files in the Cloud. [Aspose.Tasks Cloud SDK for Node.js](https://products.aspose.cloud/tasks/nodejs) wraps the REST API to make it easier for the developers to integrate Task Management features in their own cloud-based Node.js applications.
76

8-
To use these SDK, you will need App SID and App Key which can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) (free registration in Aspose Cloud is required for this).
7+
## REST API for Task Management
98

10-
### Sample usage
11-
The examples below show how your application have to initiate and get a project's tasks using aspose-tasks-cloud library:
12-
``` js
9+
- [Convert project documents](https://docs.aspose.cloud/tasks/convert-project-document-to-the-specified-format/) to other formats.
10+
- Manipulate task data.
11+
- [Manage project's resources](https://docs.aspose.cloud/tasks/working-with-resources/).
12+
- Handle task links & task assignments.
13+
- Work with project's extended attributes.
14+
- [Read Microsoft Project’s document properties](https://docs.aspose.cloud/tasks/working-with-calendars/) such as start and finish date, tasks scheduling types and so on.
15+
- [Read Microsoft Project’s Calendars](https://docs.aspose.cloud/tasks/working-with-calendars/) and Calendar Exceptions information.
16+
17+
## Read & Write Project Data
18+
19+
**Microsoft Project** MPP, XML, MPT **Primavera** MPX
20+
21+
## Save Project Data As
22+
23+
XER, XLSX, HTML, XML, TXT, TIF, SVG, PNG, JPEG
24+
25+
## Get Started with Aspose.Tasks Cloud SDK for Node.js
1326

14-
const tasksApi = new TasksApi("Youre AppSid here", "Youre AppKey here");
27+
Register an account at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) to get you application information. Next, execute `npm i @asposecloud/aspose-tasks-cloud` from the command line to install Aspose.Tasks Cloud SDK for Node.js via NPM.
1528

16-
const request: GetTasksRequest = { name: "ProjectFile.mpp", folder: "documents", storage: ""}
29+
30+
## Create MPP in the Cloud
31+
32+
``` js
33+
const tasksApi = new TasksApi("AppSid", "AppKey");
34+
const request: GetTasksRequest = { name: "template.mpp", folder: "documents", storage: ""}
1735

1836
tasksApi.getTasks(request)
1937
.then((result) => {
@@ -26,30 +44,22 @@ tasksApi.getTasks(request)
2644
console.log(err.reponse.statusCode);
2745
console.log(err.body);
2846
});
29-
3047
```
3148

32-
Every method returns a chainable promise.
49+
[Tests](test) contain various examples of using the SDK. You have to create "testConfig.json" file in project root to run every example. The "testConfig.json" has the following structure.
3350

34-
[Tests](test) contain various examples of using the SDK. You have to create "testConfig.json" file in project root to run them.
35-
"testConfig.json" has the following structure
3651
``` json
3752
{
3853
"AppSid": "Youre AppSid here",
3954
"AppKey": "Youre AppKey here",
4055
"BaseUrl": "http://api.aspose.cloud"
4156
}
4257
```
58+
## Aspose.Tasks Cloud SDKs in Popular Languages
4359

44-
For other examples, check the product [Developer Guide](https://docs.aspose.cloud/tasks/developer-guide/).
45-
46-
# Licensing
47-
All Aspose.Tasks Cloud SDKs, helper scripts and templates are licensed under [MIT License](LICENSE).
60+
| .NET | PHP | Python | Node.js |
61+
|---|---|---|---|
62+
| [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-dotnet) | [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-php) | [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-python) | [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-node) |
63+
| [NuGet](https://www.nuget.org/packages/Aspose.Tasks-Cloud/) | [Composer](https://packagist.org/packages/aspose/tasks-sdk-php) | [PIP](https://pypi.org/project/aspose-tasks-cloud/) | [NPM](https://www.npmjs.com/package/@asposecloud/aspose-tasks-cloud) |
4864

49-
# Resources
50-
+ [**Website**](https://www.aspose.cloud)
51-
+ [**Product Home**](https://products.aspose.cloud/tasks/cloud)
52-
+ [**Documentation**](https://docs.aspose.cloud/tasks/)
53-
+ [**Free Support Forum**](https://forum.aspose.cloud/c/tasks)
54-
+ [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
55-
+ [**Blog**](https://blog.aspose.cloud/category/aspose-products/aspose-tasks-product-family/)
65+
[Home](https://www.aspose.cloud) | [Product Page](https://products.aspose.cloud/tasks/nodejs) | [Documentation](https://docs.aspose.cloud/tasks/) | [Live Demo](https://products.aspose.app/tasks/family) | [API Reference](https://apireference.aspose.cloud/tasks/) | [Code Samples](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-dotnet/tree/master/Aspose.Tasks.Cloud.Sdk.Tests) | [Blog](https://blog.aspose.cloud/category/tasks/) | [Free Support](https://forum.aspose.cloud/c/tasks) | [Free Trial](https://dashboard.aspose.cloud/#/apps)

0 commit comments

Comments
 (0)