Skip to content

Commit

Permalink
NOISSUE - Rename sdk from jssdk to tssdk (#129)
Browse files Browse the repository at this point in the history
* rename sdk

Signed-off-by: wambuipixel <[email protected]>

* add changeset

Signed-off-by: wambuipixel <[email protected]>

* remove changeset

Signed-off-by: wambuipixel <[email protected]>

---------

Signed-off-by: wambuipixel <[email protected]>
  • Loading branch information
wambui-pixel authored Jan 24, 2025
1 parent 406b357 commit cd0b4a3
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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?
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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/<your-username>/sdk-js.git
cd sdk-js
git remote add upstream https://github.com/absmach/sdk-js.git
git clone https://github.com/<your-username>/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:
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -17,15 +17,15 @@ 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";
```

## Contributing

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.

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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",
Expand Down

0 comments on commit cd0b4a3

Please sign in to comment.