diff --git a/package.json b/package.json index e30c949..0822d01 100644 --- a/package.json +++ b/package.json @@ -1,13 +1,13 @@ { "name": "classcharts-api", - "version": "0.0.1", + "version": "0.0.2", "description": "", "repository": { "url": "https://github.com/jamesatjaminit/classcharts-api" }, "main": "./index.js", "scripts": { - "prepublishOnly": "pnpm tsc && node dist/release.js", + "buildReady": "pnpm tsc && node dist/release.js", "generateDocs": "pnpm typedoc --entryPointStrategy expand ./src" }, "author": "", diff --git a/readme.md b/readme.md index ec00172..9a28af4 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,28 @@ # Classcharts API A very WIP client for the classcharts API + +[Documentation](https://jamesatjaminit.github.io/classcharts-api/index.html) + +# Examples + +```typescript +import { ClasschartsClient } from 'classcharts-api' +async function main() { + const client = new ClasschartsClient('classchartsCode', '01/1/2000') + await client.init() + console.log( + await client.getBehaviour({ + displayDate: 'due_date', + fromDate: '20/01/2000', + toDate: '01/02/2000', + }) + ) + console.log(await client.getActivity(null)) + console.log(await client.getStudentInfo()) + console.log(await client.getActivity(null)) + console.log(await client.getActivity(null)) +} + +main() +``` diff --git a/src/release.ts b/src/release.ts index 1c2dd69..41c5f1f 100644 --- a/src/release.ts +++ b/src/release.ts @@ -23,6 +23,7 @@ function main() { Buffer.from(sourceObj.version, 'utf-8') ) fs.copyFileSync(__dirname + '/../.npmignore', __dirname + '/.npmignore') + fs.copyFileSync(__dirname + '/../README.MD', __dirname + '/README.MD') } main()