Skip to content

Commit

Permalink
docs: contribution notice
Browse files Browse the repository at this point in the history
  • Loading branch information
Stun3R committed Feb 17, 2022
1 parent 8c0223b commit 055b410
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,36 @@

## 🚀 Features

- Strapi v4 supports
- RESTful methods
- Simplified request responses
- Formatted error handling

[📚  Documentation](https://strapi-sdk-js.netlify.app)

> If you are using Strapi **v3**, check out [here](https://v1-strapi-sdk-js.netlify.app) the documentation of the SDK `v1`
## ⚙️ Contributing

1. Clone the repository
2. Move on `develop` branch
3. You will need to install dependencies thanks `npm install` or `yarn install`
4. To start development you can use `yarn start` in order to enable build watch or `yarn build`
5. After you finished your change be sure to open a PR against `develop` branch

## License

[MIT License](./LICENSE)

<!-- Badges -->

[actions-src]: https://github.com/Stun3R/strapi-sdk-js/actions/workflows/main.yml/badge.svg
[actions-href]: https://github.com/Stun3R/strapi-sdk-js/actions/workflows/main.yml

[codecov-src]: https://img.shields.io/codecov/c/github/Stun3R/strapi-sdk-js.svg?style=flat-square
[codecov-href]: https://codecov.io/gh/Stun3R/strapi-sdk-js

[npm-version-src]: https://img.shields.io/npm/v/strapi-sdk-js/latest.svg?style=flat-square
[npm-version-href]: https://npmjs.com/package/strapi-sdk-js

[npm-downloads-src]: https://img.shields.io/npm/dt/strapi-sdk-js.svg?style=flat-square
[npm-downloads-href]: https://npmjs.com/package/strapi-sdk-js

[license-src]: https://img.shields.io/github/license/stun3r/strapi-sdk-js.svg?style=flat-square
[license-href]: ./LICENSE
2 changes: 1 addition & 1 deletion docs/content/en/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ position: 2

<alert type="info">

If you are using Strapi **< v4**, check out [here](https://v1-strapi-sdk-js.netlify.app) the documentation of the SDK `v1`
If you are using Strapi **v3**, check out [here](https://v1-strapi-sdk-js.netlify.app) the documentation of the SDK `v1`

</alert>

Expand Down

0 comments on commit 055b410

Please sign in to comment.