Skip to content

Commit

Permalink
readme disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
a2br committed Aug 8, 2023
1 parent 7e777e5 commit a69338b
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# ecoledirecte.js · ![GitHub](https://img.shields.io/github/license/a2br/ecoledirecte.js) ![npm](https://img.shields.io/npm/v/ecoledirecte.js) ![npm](https://img.shields.io/npm/dw/ecoledirecte.js)

> **The module is still under semver 1.0.0**: This means that big changes in the methods / import architecture can happen at any time. Make sure your code is compatible with the new version after updating.
> **As of August 8, 2023, this module is no longer maintained**: This means that although the module is perfectly functioning, I will not update it to comply to future EcoleDirecte API changes. The module may fail to fetch or send data. I would greatly appreciate PRs for feature requests / bug patches, as I no longer have the time to work on this project. Thank you.
Browse EcoleDirecte's private API with the module of your dreams.
Browse EcoleDirecte's private API with ED.js, an unofficial API client.

`ed.js` is a Promise-based module, built on TypeScript for a better IntelliSense and type-guarded, solid features. It keeps evolving and new features are being added.
`ed.js` is a Promise-based module, built on TypeScript for a better IntelliSense and type-guarded features.

## Examples

> Warning: these examples might not work on your machine (depending on whether you're using `commonjs` or ES6 `module`)
### Get the homework of a day
Expand Down

0 comments on commit a69338b

Please sign in to comment.