You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-24Lines changed: 6 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,36 +1,18 @@
1
1
<imgalt="Unilim: A purrfect API wrapper for Unilim"src="https://raw.githubusercontent.com/LiterateInk/Unilim.js/main/.github/assets/banner.svg"width="100%" />
2
2
3
-
_This library **is not** affiliated with [↗ University of Limoges](https://unilim.fr/) in any way._
3
+
_This library **is not** affiliated with [University of Limoges](https://unilim.fr/) in any way._
4
4
5
5
## What is "Unilim" ?
6
6
7
-
University of Limoges (Unilim) is a French university that offers a wide range of courses in various fields. You can find more information about it on their [↗ official website](https://unilim.fr/).
7
+
University of Limoges (Unilim) is a French university that offers a wide range of courses in various fields. You can find more information about it on their [official website](https://unilim.fr/).
8
8
9
-
## Installation
9
+
## Get Started
10
10
11
-
Use your favorite package manager to install this library from the npm registry.
11
+
Jump right in by following the [**Installation Guide**](https://unilim.docs.literate.ink/guides/getting-started/installation/) to set things up.
12
12
13
-
```bash
14
-
# pnpm
15
-
pnpm add unilim
13
+
Once in, explore annotated examples in the [**official documentation**](https://unilim.docs.literate.ink/guides/examples/) or check out the [`examples` folder on GitHub](https://github.com/LiterateInk/Unilim.js/tree/main/examples). You can also browse the full [**API Reference**](https://js.unilim.docs.literate.ink/) for details.
16
14
17
-
# Yarn
18
-
yarn add unilim
19
-
20
-
# npm
21
-
npm add unilim
22
-
23
-
# Bun
24
-
bun add unilim
25
-
```
26
-
27
-
## Quick Start
28
-
29
-
> TODO
30
-
31
-
You can find guides at [**↗ unilim.docs.literate.ink**](https://unilim.docs.literate.ink) and if it's not enough you can also take a look at the [**↗ examples** directory on the GitHub repository](https://github.com/LiterateInk/Unilim.js/tree/main/examples) for inspiration.
32
-
33
-
If none of those are helpful, you can always [↗ open an issue](https://github.com/LiterateInk/Unilim.js/issues) to ask for help or join the [↗ LiterateInk Discord server](https://literate.ink/discord).
15
+
Still stuck ? [Open an issue](https://github.com/LiterateInk/Unilim.js/issues) or join the conversation on [Discord](https://literate.ink/discord) and ask for help in the appropriate channel.
0 commit comments