Update README.md

Author: yulmwu

README.md

@@ -1,3 +1,8 @@
+-   [Gist API](./README.md#gist-api)
+-   [Docs](./README.md#docs)
+-   [Examples](./README.md#example)
+-   [Status codes](./README.md#status-codes)
+
 # Gist API
 
 ```sh
@@ -12,7 +17,7 @@ npm i @tsukiroku/gist
 
 ## Initialize
 
-> Account token required. See [Docs](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
+> **Note:** Account token required. See [Docs](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
 
 ```ts
 import Gist from '@tsukiroku/gist';
@@ -42,9 +47,9 @@ const gist = new Gist('token');
 > { secret: boolean, ... }
 > ```
 >
-> **secret** default: true
+> **Note:** **secret** default: true
 
-> **return:** [`Promise<GistResponse>`](./src/types.ts)
+> **return:** [`Promise<ReqRet<GistResponse>>`](./src/types.ts)
 
 ```ts
 await gist
@@ -57,7 +62,7 @@ await gist
         // { secret: true }
     )
     .then((res) => {
-        console.log(`Gist created: ${gist_id}`);
+        console.log(`Gist created: ${res.data!.id}`);
     })
     .catch((err) => console.log(err));
 ```
@@ -70,12 +75,12 @@ await gist
 | --------- | -------- |
 | `id`      | `number` |
 
-> **return:** [`Promise<GistResponse>`](./src/types.ts)
+> **return:** [`Promise<ReqRet<GistResponse>>`](./src/types.ts)
 
 ```ts
 await gist
     .get('gist id')
-    .then((res) => console.log(`gist description: ${res.description}`))
+    .then((res) => console.log(`gist description: ${res.data!.description}`))
     .catch((err) => console.log(err));
 ```
 
@@ -87,11 +92,15 @@ await gist
 | --------- | -------- |
 | `id`      | `number` |
 
+> **return:** [`Promise<ReqRet<{}>>`](./src/types.ts)
+>
+> **Note:** `res.data` is undefined.
+
 ```ts
 await gist
-    .delete('gist id')
-    .then((_) => console.log('deleted'))
-    .catch((err) => console.log(err));
+    .delete(gist_id)
+    .then((res) => console.log(`Gist deleted, status: ${res.status.code}`))
+    .catch(errHandler);
 ```
 
 <br>
@@ -105,34 +114,63 @@ await gist
 ```ts
 import Gist from '@tsukiroku/gist';
 
+const errHandler = (err: any) => console.log(err);
+
 (async () => {
     const gist = new Gist('token');
 
     let gist_id: string = '';
 
     await gist
         .create(
-            {
-                'index.ts': { content: "console.log('Hello, World!');" },
-                'main.rs': { content: 'fn main() {}' },
-            },
-            'test gist',
+            { 'hello.ts': { content: 'dd' }, 'hello.rs': { content: 'ddd' } },
+            'a test file',
             { secret: true }
         )
         .then((res) => {
-            gist_id = res.id;
+            gist_id = res.data!.id;
             console.log(`Gist created: ${gist_id}`);
         })
-        .catch((err) => console.log(err));
+        .catch(errHandler);
 
     await gist
         .get(gist_id)
-        .then((res) => console.log(`gist description: ${res.description}`))
-        .catch((err) => console.log(err));
+        .then((res) =>
+            console.log(`Gist description: ${res.data!.description}`)
+        )
+        .catch(errHandler);
 
     await gist
         .delete(gist_id)
-        .then((_) => console.log('deleted'))
-        .catch((err) => console.log(err));
+        .then((res) => console.log(`Gist deleted, status: ${res.status.code}`))
+        .catch(errHandler);
 })();
 ```
+
+# Status codes
+
+> **ref:** [http_status.ts](./src/structures/http_status.ts)
+
+| Status code | Name                  |
+| ----------- | --------------------- |
+| 200         | OK                    |
+| 201         | CREATED               |
+| 204         | NO_CONTENT            |
+| 304         | NOT_MODIFIED          |
+| 400         | BAD_REQUEST           |
+| 401         | UNAUTHORIZED          |
+| 403         | FORBIDDEN             |
+| 404         | NOT_FOUND             |
+| 409         | CONFLICT              |
+| 422         | VAILDATION_FAILED     |
+| 500         | INTERNAL_SERVER_ERROR |
+| 502         | BAD_GATEWAY           |
+| 503         | SERVICE_UNAVAILABLE   |
+| 504         | GATEWAY_TIMEOUT       |
+| -1          | UNKNOWN               |
+
+---
+
+[**LICENSE: MIT**](./LICENSE)
+
+> Click [here](https://docs.github.com/en/rest/gists) for more information on the github gists rest API.