Skip to content

Commit 3998840

Browse files
committed
docs: add quick start section and what about appscho
1 parent 24e3d3f commit 3998840

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## What is "AppScho" ?
88

9-
TODO
9+
[↗ AppScho](https://www.appscho.com/) is an all-in-one mobile app which centralizes everything students need - class schedules, grades, campus news, internship offers - into one intuitive platform. Built for universities and higher education institutions, AppScho strengthens engagement and simplifies communication, making campus life more connected and efficient.
1010

1111
## Installation
1212

@@ -33,7 +33,19 @@ bun add appscho
3333
```typescript
3434
import * as AppScho from "appscho";
3535

36-
// TODO
36+
// The instance you want to use.
37+
// You can get a list of them by using AppScho.INSTANCES (Array<Instance>) constant.
38+
const instance = "univpoitiers";
39+
40+
const user = await AppScho.login(instance, "username", "password");
41+
console.log(user);
42+
43+
// Retrieve the list of all Crous available for this instance.
44+
const crous = await AppScho.getCrous(instance, user.token);
45+
46+
// Let's retrieve restaurants from the first Crous.
47+
const restaurants = await AppScho.getCrousRestaurants(instance, user.token, crous[0].id);
48+
console.log(restaurants);
3749
```
3850

3951
You can find guides at [**&nearr;&nbsp;appscho.docs.literate.ink**](https://appscho.docs.literate.ink) and if it's not enough you can also take a look at the [**&nearr;&nbsp;examples** directory on the GitHub repository](https://github.com/LiterateInk/AppScho.JS/tree/main/examples) for inspiration.

0 commit comments

Comments
 (0)