update to docs

lavgup · Oct 20, 2020 · 7b74c83 · 7b74c83
1 parent de252fe
commit 7b74c83
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 13 deletions.
diff --git a/.npmignore b/.npmignore
@@ -1,2 +1,3 @@
 src/
-pnpm-lock.yaml
+pnpm-lock.yaml
+.idea/
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-A wrapper for the [VACEfron API](https://vacefron.nl/api) in JavaScript.
+A wrapper for the [VACEfron API](https://vacefron.nl/api) in TypeScript.
 
 ## Installation
 With pnpm (recommended):
@@ -17,10 +17,9 @@ yarn add vacefron
 ```
 
 ## Documentation
-Check [docs.md](docs.md);
+Check [docs.md](docs.md).
 
 ## Example usages
-All methods return `Promise<Buffer>`.
 ### Basic
 ```js
 const vacefron = require('vacefron');
@@ -54,6 +53,4 @@ client.login('token');
 * [Python](https://github.com/Soheab/vacefron.py/)
 
 ## Contributing
-Anyone can contribute! Please just make them merge-worthy changes.
-
-I may do a TypeScript rewrite of this wrapper when I have more experience with it.
+Anyone can contribute! Please just make them merge-worthy changes.
diff --git a/docs.md b/docs.md
@@ -1,7 +1,6 @@
 Documentation of the wrapper's methods.
 
-Properties in *italics* are not required.
-All methods return `Promise<Buffer>`.
+Properties in *italics* are not required. All methods return `Promise<Buffer>`.
 
 - [Methods](#methods)
   * [carReverse()](#carreverse)
@@ -39,7 +38,7 @@ girlfriendAvatarURL `string` | Avatar URL for the girlfriend's face.
 
 name `string` | Name of the player.
 
-*wasImposter* `boolean` | Whether the play is the imposter.
+*wasImposter* `boolean` | Whether the player is the imposter.
 
 *color* `black|blue|brown|cyan|darkgreen|lime|orange|pink|purple|red|white|yellow` | The color of the player.
 
@@ -90,13 +89,13 @@ rank `number` | The ranking of the user.
 
 currentXP `number` | The amount of XP the user currently has.
 
-nextLevelXP `number` | How much XP is required to reach the next level.
+nextLevelXP `number` | XP required to reach the next level.
 
-previousLevelXP `number` | How much XP was required to reach the user's current level.
+previousLevelXP `number` | XP required to reach the user's current level.
 
 xpColor `string` | The color (hex) of the XP bar.
 
-isBoosting `boolean` | Whether a boost badge will be displayed next to the user's name if they are XP boosting.
+isBoosting `boolean` | Whether a boost badge will be displayed next to the user's name.
 
 ### stonks()
 **Parameters**: