mirror of
https://github.com/classchartsapi/classcharts-api-js.git
synced 2026-05-11 18:59:05 +00:00
chore: move docs to readme
This commit is contained in:
parent
4c871a3112
commit
780322f3e2
5 changed files with 10 additions and 29 deletions
3
.github/workflows/release.yml
vendored
3
.github/workflows/release.yml
vendored
|
|
@ -24,6 +24,9 @@ jobs:
|
||||||
with:
|
with:
|
||||||
node-version: "18.x"
|
node-version: "18.x"
|
||||||
registry-url: "https://registry.npmjs.org"
|
registry-url: "https://registry.npmjs.org"
|
||||||
|
- uses: pnpm/action-setup@v2
|
||||||
|
with:
|
||||||
|
version: 8
|
||||||
- name: npm build
|
- name: npm build
|
||||||
run: deno task npm ${{steps.get_tag_version.outputs.TAG_VERSION}}
|
run: deno task npm ${{steps.get_tag_version.outputs.TAG_VERSION}}
|
||||||
- name: npm publish
|
- name: npm publish
|
||||||
|
|
|
||||||
|
|
@ -30,6 +30,13 @@ For any help with the library, please join the
|
||||||
[discord](https://discord.gg/DTcwugcgZ2) where you can ask questions and get
|
[discord](https://discord.gg/DTcwugcgZ2) where you can ask questions and get
|
||||||
help from the community.
|
help from the community.
|
||||||
|
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
Contributions are welcome! There are lots of API endpoints which we simply do
|
||||||
|
not have access to to implement, so if you have access to them, please consider
|
||||||
|
contributing! If you have any questions, feel free to ask in the
|
||||||
|
[discord](https://discord.gg/DTcwugcgZ2).
|
||||||
|
|
||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
29
readme.md
29
readme.md
|
|
@ -1,29 +0,0 @@
|
||||||
<h1 align="center">Classcharts API JS</h1>
|
|
||||||
<div align="center">
|
|
||||||
<a href="https://discord.gg/DTcwugcgZ2"><img alt="Discord" src="https://img.shields.io/discord/918103752068726855"></a>
|
|
||||||
<a href="https://github.com/classchartsapi/classcharts-api-js/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/npm/l/classcharts-api"></a>
|
|
||||||
<a href="https://www.npmjs.com/package/classcharts-api"><img alt="npm" src="https://img.shields.io/npm/v/classcharts-api"></a>
|
|
||||||
<a href="https://deno.land/x/classcharts_api"><img alt="deno" src="https://shield.deno.dev/x/classcharts_api"></a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<p align="center">A Node.js and Deno wrapper for getting information from the Classcharts API.</p>
|
|
||||||
|
|
||||||
# Links
|
|
||||||
|
|
||||||
- [Documentation](https://classchartsapi.github.io/classcharts-api-js/)
|
|
||||||
- [Discord](https://discord.gg/DTcwugcgZ2)
|
|
||||||
- [NPM](https://www.npmjs.com/package/classcharts-api)
|
|
||||||
- [Deno](https://deno.land/x/classcharts_api)
|
|
||||||
|
|
||||||
# Contributing
|
|
||||||
|
|
||||||
Contributions are welcome! There are lots of API endpoints which we simply do
|
|
||||||
not have access to to implement, so if you have access to them, please consider
|
|
||||||
contributing! If you have any questions, feel free to ask in the
|
|
||||||
[discord](https://discord.gg/DTcwugcgZ2).
|
|
||||||
|
|
||||||
# Help
|
|
||||||
|
|
||||||
For any help with the library, please join the
|
|
||||||
[discord](https://discord.gg/DTcwugcgZ2) where you can ask questions and get
|
|
||||||
help from the community.
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue