Skip to content

Commit 94ea49e

Browse files
committed
feat(example): create README
1 parent a9c2e99 commit 94ea49e

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

Diff for: example/README.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# JSON:API Client Example
2+
3+
This folder contains example to demonstrate the usage of the [`@stantanasi/jsonapi-client`](https://www.npmjs.com/package/@stantanasi/jsonapi-client) package
4+
5+
Refer to [`./src/index.ts`](./src/index.ts) and other files for example usage
6+
7+
## Getting started
8+
9+
### Prerequisites
10+
11+
- Install [Node.js](https://nodejs.org) which includes [Node Package Manager](https://www.npmjs.com/get-npm)
12+
13+
### Setup
14+
15+
Install the packages required
16+
17+
```bash
18+
npm install
19+
```
20+
21+
## Development
22+
23+
Run the application
24+
25+
```bash
26+
npm run start
27+
```
28+
29+
You can freely modify [`./src/index.ts`](./src/index.ts) and other files to test
30+
31+
## Author
32+
33+
- [Lory-Stan TANASI](https://github.com/stantanasi)
34+
35+
## License
36+
37+
This project is licensed under the `Apache-2.0` License - see the [LICENSE](LICENSE) file for details
38+
39+
<p align="center">
40+
<br />
41+
© 2025 Lory-Stan TANASI. All rights reserved
42+
</p>

0 commit comments

Comments
 (0)