tuitio-client/README.md

27 lines
780 B
Markdown
Raw Normal View History

2023-02-07 00:32:31 +02:00
# Tuitio connector
## Introduction
Tuitio connector 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).
## Package installation
The package installation can be done in two ways:
- from the command line: `npm install @flare/tuitio-connector@1.0.0`
- from the package.json file: `"@flare/tuitio-connector": "1.0.0"`
## How to use the package
TO DO
## Unit testing
Unit testing is done using [Jest](https://jestjs.io/). This is an awesome testing framework created by Facebook.
The files containing tests are identified by the extension `*.test.ts`.
All tests in the package can be executed by running: `npm test`.
## Changelog
1.0.0 - Package initialization