Skip to content

Commit b36ed4b

Browse files
committed
docs: follow template
1 parent 26063da commit b36ed4b

File tree

1 file changed

+6
-24
lines changed

1 file changed

+6
-24
lines changed

README.md

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,18 @@
11
<img alt="Unilim: A purrfect API wrapper for Unilim" src="https://raw.githubusercontent.com/LiterateInk/Unilim.js/main/.github/assets/banner.svg" width="100%" />
22

3-
_This library **is not** affiliated with [&nearr;&nbsp;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._
44

55
## What is "Unilim" ?
66

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 [&nearr;&nbsp;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/).
88

9-
## Installation
9+
## Get Started
1010

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.
1212

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.
1614

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 [**&nearr;&nbsp;unilim.docs.literate.ink**](https://unilim.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/Unilim.js/tree/main/examples) for inspiration.
32-
33-
If none of those are helpful, you can always [&nearr;&nbsp;open an issue](https://github.com/LiterateInk/Unilim.js/issues) to ask for help or join the [&nearr;&nbsp;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.
3416

3517
## License
3618

0 commit comments

Comments
 (0)