diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 764a06ce..5589007e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -Pull request title should be `JSSDK-XXX - description` or `NOISSUE - description` where XXX is ID of issue that this PR relate to. +Pull request title should be `TSSDK-XXX - description` or `NOISSUE - description` where XXX is ID of issue that this PR relate to. Please review the [CONTRIBUTING.md](./CONTRIBUTING.md) file for detailed contributing guidelines. ### What does this do? diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 38a25f6d..a8669d26 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ Reporting issues are a great way to contribute to the project. We are perpetuall thorough bug report. Before raising a new issue, check [our issue -list](https://github.com/absmach/sdk-js/issues) to determine if it already contains the +list](https://github.com/absmach/magistrala-sdk-ts/issues) to determine if it already contains the problem that you are facing. A good bug report shouldn't leave others needing to chase you for more information. Please be as detailed as possible. The following questions might serve as a template for writing a detailed @@ -45,9 +45,9 @@ To contribute to the project, , [fork](https://help.github.com/articles/fork-a-r clone your fork repository, and configure the remotes: ``` -git clone https://github.com//sdk-js.git -cd sdk-js -git remote add upstream https://github.com/absmach/sdk-js.git +git clone https://github.com//magistrala-sdk-ts.git +cd magistrala-sdk-ts +git remote add upstream https://github.com/absmach/magistrala-sdk-ts.git ``` If your cloned repository is behind the upstream commits, then get the latest changes from upstrem: diff --git a/README.md b/README.md index dcdce881..c4b64708 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# Magistrala JavaScript SDK +# Magistrala Typescript SDK [![NPM package](https://img.shields.io/npm/v/@absmach/magistrala-sdk.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen)][npm] [![license][license]](LICENSE) [![chat][gitter-badge]][gitter] -Magistrala javascript sdk is a javascript driver for [Magistrala HTTP API][docs] API reference in the Swagger UI can be found [here][api]. +Magistrala typescript sdk is a typescript driver for [Magistrala HTTP API][docs] API reference in the Swagger UI can be found [here][api]. It does both system administration (provisioning) and messaging. ## Install @@ -17,7 +17,7 @@ npm install @absmach/magistrala-sdk Once the package is installed you can import the library using 'import': -```js +```ts import SDK from "@absmach/magistrala-sdk"; ``` @@ -25,7 +25,7 @@ import SDK from "@absmach/magistrala-sdk"; Thank you for your interest in Magistrala-sdk and the desire to contribute! -1. Take a look at our [open issues](https://github.com/absmach/sdk-js/issues). The [good-first-issue](https://github.com/absmach/sdk-js/labels/good-first-issue) label is specifically for issues that are great for getting started. +1. Take a look at our [open issues](https://github.com/absmach/magistrala-sdk-ts/issues). The [good-first-issue](https://github.com/absmach/magistrala-sdk-ts/labels/good-first-issue) label is specifically for issues that are great for getting started. 2. Checkout the [contribution guide][contributing] to learn more about our style and conventions. 3. Make your changes compatible to our workflow. diff --git a/package-lock.json b/package-lock.json index 81fc12bb..8600e5b4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@absmach/magistrala-sdk", - "version": "0.9.4", + "version": "0.10.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@absmach/magistrala-sdk", - "version": "0.9.4", + "version": "0.10.3", "license": "Apache-2.0", "dependencies": { "@changesets/cli": "^2.27.6", diff --git a/package.json b/package.json index adc73192..130b6e81 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,7 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/absmach/sdk-js.git" + "url": "git+https://github.com/absmach/magistrala-sdk-ts.git" }, "publishConfig": { "access": "public" @@ -35,9 +35,9 @@ "author": "Abstract Machines", "license": "Apache-2.0", "bugs": { - "url": "https://github.com/absmach/sdk-js/issues" + "url": "https://github.com/absmach/magistrala-sdk-ts/issues" }, - "homepage": "https://github.com/absmach/sdk-js#readme", + "homepage": "https://github.com/absmach/magistrala-sdk-ts#readme", "dependencies": { "@changesets/cli": "^2.27.6", "node-fetch": "^3.3.2",