From 780322f3e26da03e88efbdcfc65c5f8af505042f Mon Sep 17 00:00:00 2001 From: James Cook Date: Wed, 30 Aug 2023 16:00:24 +0100 Subject: [PATCH] chore: move docs to readme --- .github/workflows/release.yml | 3 +++ docs/.nojekyll => .nojekyll | 0 docs/README.md => README.md | 7 +++++++ docs/index.html => index.html | 0 readme.md | 29 ----------------------------- 5 files changed, 10 insertions(+), 29 deletions(-) rename docs/.nojekyll => .nojekyll (100%) rename docs/README.md => README.md (95%) rename docs/index.html => index.html (100%) delete mode 100644 readme.md diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 3d40b32..7c9c71b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -24,6 +24,9 @@ jobs: with: node-version: "18.x" registry-url: "https://registry.npmjs.org" + - uses: pnpm/action-setup@v2 + with: + version: 8 - name: npm build run: deno task npm ${{steps.get_tag_version.outputs.TAG_VERSION}} - name: npm publish diff --git a/docs/.nojekyll b/.nojekyll similarity index 100% rename from docs/.nojekyll rename to .nojekyll diff --git a/docs/README.md b/README.md similarity index 95% rename from docs/README.md rename to README.md index 477c8aa..cf64709 100644 --- a/docs/README.md +++ b/README.md @@ -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 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 ## Requirements diff --git a/docs/index.html b/index.html similarity index 100% rename from docs/index.html rename to index.html diff --git a/readme.md b/readme.md deleted file mode 100644 index 4d6a526..0000000 --- a/readme.md +++ /dev/null @@ -1,29 +0,0 @@ -

Classcharts API JS

-
- Discord - license - npm - deno -
- -

A Node.js and Deno wrapper for getting information from the Classcharts API.

- -# 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.