diff --git a/README.md b/README.md index d4d10b2..583980a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Tuitio react client +# Tuitio client react ## Introduction -Tuitio react client is an npm package written in typescript that facilitates the integration of a react application with [Tuitio](https://lab.code-rove.com/gitea/tudor.stanciu/tuitio). +Tuitio client react is an npm package written in typescript that facilitates the integration of a react application with [Tuitio](https://lab.code-rove.com/gitea/tudor.stanciu/tuitio). This package uses [tuitio-client](https://lab.code-rove.com/gitea/bricks/tuitio-client#readme) internally and adds state management through react contexts and various react hooks through which the user has access to data and actions. @@ -10,20 +10,20 @@ This package uses [tuitio-client](https://lab.code-rove.com/gitea/bricks/tuitio- The package installation can be done in two ways: -- from the command line: `npm install @flare/tuitio-react-client@1.0.0` -- from the package.json file: `"@flare/tuitio-react-client": "1.0.0"` +- from the command line: `npm install @flare/tuitio-client-react@1.0.0` +- from the package.json file: `"@flare/tuitio-client-react": "1.0.0"` ## How to use the package ```javascript! -const { TuitioProvider, useTuitioClient, useTuitioUser, useTuitioToken } = require("@flare/tuitio-react-client"); -const TuitioProvider = require("@flare/tuitio-react-client"); +const { TuitioProvider, useTuitioClient, useTuitioUser, useTuitioToken } = require("@flare/tuitio-client-react"); +const TuitioProvider = require("@flare/tuitio-client-react"); ``` ```javascript! -import { TuitioProvider, useTuitioClient, useTuitioUser, useTuitioToken } from "@flare/tuitio-react-client"; -import TuitioProvider from "@flare/tuitio-react-client"; +import { TuitioProvider, useTuitioClient, useTuitioUser, useTuitioToken } from "@flare/tuitio-client-react"; +import TuitioProvider from "@flare/tuitio-client-react"; ``` ## Unit testing diff --git a/package-lock.json b/package-lock.json index 9bd197b..fc8a59d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "@flare/tuitio-react-client", + "name": "@flare/tuitio-client-react", "version": "1.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "@flare/tuitio-react-client", + "name": "@flare/tuitio-client-react", "version": "1.0.0", "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 7480bbf..c5e984d 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "@flare/tuitio-react-client", + "name": "@flare/tuitio-client-react", "version": "1.0.0", - "description": "Tuitio react client is an npm package written in typescript that facilitates the integration of a react application with Tuitio.", + "description": "Tuitio client react is an npm package written in typescript that facilitates the integration of a react application with Tuitio.", "main": "./dist/cjs/index.js", "module": "./dist/esm/index.js", "types": "./dist/esm/index.d.ts", @@ -26,11 +26,11 @@ }, "repository": { "type": "git", - "url": "https://lab.code-rove.com/gitea/bricks/tuitio-react-client.git" + "url": "https://lab.code-rove.com/gitea/bricks/tuitio-client-react.git" }, "keywords": [ "flare", - "tuitio-react-client" + "tuitio-client-react" ], "author": { "name": "Tudor Stanciu", @@ -39,9 +39,9 @@ }, "license": "MIT", "bugs": { - "url": "https://lab.code-rove.com/gitea/bricks/tuitio-react-client/issues" + "url": "https://lab.code-rove.com/gitea/bricks/tuitio-client-react/issues" }, - "homepage": "https://lab.code-rove.com/gitea/bricks/tuitio-react-client#readme", + "homepage": "https://lab.code-rove.com/gitea/bricks/tuitio-client-react#readme", "files": [ "dist", "LICENSE",