Skip to content
This repository was archived by the owner on Sep 6, 2021. It is now read-only.

Commit 4138f1e

Browse files
authored
Update README.md
1 parent dbefb28 commit 4138f1e

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,40 +62,44 @@
6262

6363
[![Code Screenshot](images/screenshot.jpg)](https://repl.it/@RayhanADev/REPLAPIit-Replit-API-Package)
6464

65+
The Repl.it GraphQL API is an extraordinary way to make projects unique and special, yet with the numerous packages available few such projects have been made. Why would that be? Most likely due to how complicated writing code can get and the limitations of their queries. My package, **ReplAPI.it**, changes that with a simple to use structure and many queries, some of which are:
6566

67+
* Queries for Data on Users (such as Profile, Posts, Comments)
68+
* Queries for Data on Posts (such as Upvoters, Content)
69+
* Queries for Data on Notifications (such as Reply Notifications, Achievement Notifications)
70+
* Mutations for Commenting, Reporting, and Posting
71+
* Queries for Data on Leaderboard (with filters such as cycles since)
72+
* and lots more!
6673

74+
My package is also simple to use with it's **class-based structure**. Simply create a new class for you User, Post, or whatever you heart desires and use built in functions with options to query data **your way**.
6775

6876
### Built With
6977

7078
* [NodeJS](https://github.com/nodejs/node)
7179

72-
<!-- GETTING STARTED -->
7380
## Getting Started
7481

75-
To get a local copy up and running follow these simple steps.
82+
I suggest requiring the ReplAPI.it module until ES imports in NodeJS are stabilized.
7683

7784
### Prerequisites
7885

79-
This is an example of how to list things you need to use the software and how to install them.
86+
If you have not already download npm:
8087
* npm
8188
```sh
8289
npm install npm@latest -g
8390
```
8491

8592
### Installation
8693

87-
1. Clone the repo
94+
1. Install the latest version
8895
```sh
89-
git clone https://github.com/RayhanADev/REPLAPI.it.git
96+
$ npm install replapi-it
9097
```
91-
2. Install NPM packages
92-
```sh
93-
npm install
98+
2. Require the package
99+
```js
100+
const repl = require('replapi-it');
94101
```
95102

96-
97-
98-
<!-- USAGE EXAMPLES -->
99103
## Usage
100104

101105
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

0 commit comments

Comments
 (0)