Skip to content

Commit

Permalink
docs: add main introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
Vexcited committed Sep 21, 2023
1 parent 9f6c7cf commit 49bf5e4
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# EDT with API for the IUT Informatique of Limoges
# EDT for the IUT Informatique of Limoges

> A random as hell project, once again...
Contains a very simple [NPM package for Node.js](https://www.npmjs.com/package/edt-iut-info-limoges) that allows you to get and parse the timetable of the IUT Informatique of Limoges in a very simple and intuitive way.

## API from the website
A demonstration website has been made to showcase the package: *TODO*, you can find the source code for it in the section below.

In development...
## Sources

Since this is a monorepo, the sources are located in the `packages` directory.

- [`packages/library`](./packages/library/): the [`edt-iut-info-limoges`](https://www.npmjs.com/package/edt-iut-info-limoges) library itself ;
- [`packages/website`](./packages/website/): the website for the demo of the library.

0 comments on commit 49bf5e4

Please sign in to comment.