-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
13 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,30 @@ | ||
# AwRD - An awmazing API wrapper for ARD GEC | ||
# PawRD - An awmazing API wrapper for ARD GEC | ||
|
||
A simple wrapper around [ARD GEC](https://www.ard.fr/produits-services/gamme-gec/) internal API. | ||
|
||
> This project is not affiliated with [ARD](https://www.ard.fr) in any way. | ||
## Installation | ||
|
||
Use your favorite package manager to install [AwRD from NPM](https://www.npmjs.com/package/awrd). | ||
Use your favorite package manager to install [PawRD from NPM](https://www.npmjs.com/package/pawrd). | ||
|
||
```bash | ||
# pnpm | ||
pnpm add awrd | ||
pnpm add pawrd | ||
|
||
# Yarn | ||
yarn add awrd | ||
yarn add pawrd | ||
|
||
# npm | ||
npm install awrd | ||
npm install pawrd | ||
``` | ||
|
||
## Documentation & Guides | ||
|
||
You can find the documentation, some guides and small examples at [literate.ink/awrd](https://literate.ink/awrd) for more information about the API and how to use it. | ||
You can find the documentation, some guides and small examples at [literate.ink/pawrd](https://literate.ink/pawrd) for more information about the API and how to use it. | ||
|
||
If you need complete examples, then we got **a lot** of those in the [`examples`](https://github.com/LiterateInk/AwRD/tree/js/examples) folder, hoping you can find your joy in there. | ||
If you need complete examples, then we got **a lot** of those in the [`examples`](https://github.com/LiterateInk/PawRD/tree/js/examples) folder, hoping you can find your joy in there. | ||
|
||
If none of those are helpful, you can always [open an issue](https://github.com/LiterateInk/AwRD/issues) to ask for help. | ||
If none of those are helpful, you can always [open an issue](https://github.com/LiterateInk/PawRD/issues) to ask for help. | ||
|
||
You can also join [LiterateInk's Discord server](https://literate.ink/discord) to talk about AwRD, get help and be notified about the latest updates ! | ||
You can also join [LiterateInk's Discord server](https://literate.ink/discord) to talk about PawRD, get help and be notified about the latest updates ! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
{ | ||
"name": "awrd", | ||
"name": "pawrd", | ||
"version": "0.0.0", | ||
"description": "A simple wrapper around ARD internal API.", | ||
"repository": "github:LiterateInk/AwRD", | ||
"repository": "github:LiterateInk/PawRD", | ||
"main": "./dist/index.js", | ||
"module": "./dist/index.mjs", | ||
"types": "./dist/index.d.ts", | ||
|
@@ -30,9 +30,9 @@ | |
"France" | ||
], | ||
"author": "Mikkel RINGAUD <[email protected]> (https://github.com/Vexcited)", | ||
"homepage": "https://literate.ink/awrd", | ||
"homepage": "https://literate.ink/pawrd", | ||
"bugs": { | ||
"url": "https://github.com/LiterateInk/AwRD/issues" | ||
"url": "https://github.com/LiterateInk/PawRD/issues" | ||
}, | ||
"license": "GPL-3.0", | ||
"engines": { | ||
|