diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 94d9c15..3d40b32 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -25,7 +25,7 @@ jobs: node-version: "18.x" registry-url: "https://registry.npmjs.org" - name: npm build - run: deno task -A npm ${{steps.get_tag_version.outputs.TAG_VERSION}} + run: deno task npm ${{steps.get_tag_version.outputs.TAG_VERSION}} - name: npm publish if: startsWith(github.ref, 'refs/tags/') env: diff --git a/docs/README.md b/docs/README.md index 8f9131c..91f5d80 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,7 @@
- A typescript wrapper for getting information from the Classcharts API + A Node.js and Deno Typescript wrapper for getting information from the Classcharts API.
@@ -10,6 +10,8 @@
Issues
•
NPM
+ •
+ Deno
•
Discord
•
@@ -33,6 +35,7 @@ help from the community.
## Requirements
- Node.js 18 or newer
+- Deno
## NPM
@@ -40,12 +43,16 @@ help from the community.
npm install classcharts-api # npm
```
-```bash
-yarn add classcharts-api # yarn
-```
+## Deno
-```bash
-pnpm add classcharts-api # pnpm
+The imports in the examples are for Node.js, but can easily be substituted for
+Deno.
+
+```typescript
+import {
+ ParentClient,
+ StudentClient,
+} from "https://deno.land/x/classcharts_api/mod.ts";
```
# Logging In
@@ -56,7 +63,7 @@ session ID which will be used for all requests.
## Student Client
```typescript
-import { StudentClient } from "classcharts-api";
+import { StudentClient } from "classcharts-api"; // Node.js
// Date of birth MUST in the format DD/MM/YYYY
const client = new StudentClient("classchartsCode", "01/1/2000");
diff --git a/readme.md b/readme.md
index dd0354f..f4eac6d 100644
--- a/readme.md
+++ b/readme.md
@@ -7,7 +7,7 @@
-
A typescript wrapper for getting information from the Classcharts API.
+A Node.js and Deno Typescript wrapper for getting information from the Classcharts API.
# Links diff --git a/typedoc.config.cjs b/typedoc.config.cjs deleted file mode 100644 index 9ecd167..0000000 --- a/typedoc.config.cjs +++ /dev/null @@ -1,22 +0,0 @@ -/** @type {import('typedoc-plugin-umami').TypeDocOptions} */ -module.exports = { - entryPointStrategy: "resolve", - plugin: ["typedoc-plugin-umami"], - entryPoints: [ - "src/core/studentClient.ts", - "src/core/parentClient.ts", - "src/core/baseClient.ts", - "src/types.ts", - ], - navigationLinks: { - Discord: "https://discord.gg/DTcwugcgZ2", - Github: "https://github.com/classchartsapi/classcharts-api-js", - }, - includeVersion: true, - out: "docs/typedoc", - sort: "required-first", - umamiOptions: { - src: "https://umami.jaminit.co.uk/script.js", - websiteId: "dd8c53b8-dc99-484c-911d-b08c898498a8", - }, -};