simple-github-gist-api 2.0.0 → 2.0.4

package/README.md

@@ -2,6 +2,9 @@
 
 <p>
 <img alt="npm" src="https://img.shields.io/npm/dt/simple-github-gist-api">
+<a href="https://www.npmjs.com/package/simple-github-gist-api">
+  <img alt="npm" src="https://img.shields.io/npm/v/simple-github-gist-api">
+</a>
 </p>
 
 > This documentation is for v2 of the lib. v2 has a few breaking changes.
@@ -20,35 +23,39 @@ need to make those tedious HTTP requests.
 > And you have an endpoint `/create-file`.
 > 
 > Think multiple people making request at the same time:
->   /create-file?name=1.json
->   /create-file?name=2.json
->   /create-file?name=3.json
->   ...
-> 
+```
+/create-file?name=1.json
+/create-file?name=2.json
+/create-file?name=3.json
+...
+```
+
 > If this happens at the same time, then we cannot guarantee that the 
 > all the files will be saved. Maybe when creating both 2.json and 3.json,
 > we are making use of the same commit-id. Both will work but 1 will over-write 
 > the other commit.
 > 
 > But if you do:
-> 
-> const file1 = gist.createFile('1.json', "{}")
-> const file2 = gist.createFile('2.json', "{}")
-> const file3 = gist.createFile('3.json', "{}")
-> 
-> await file1.save();
-> await file2.save();
-> await file3.save();
+
+```ts
+const file1 = gist.createFile('1.json', "{}")
+const file2 = gist.createFile('2.json', "{}")
+const file3 = gist.createFile('3.json', "{}")
+
+await file1.save();
+await file2.save();
+await file3.save();
+```
 > 
 > this will work as the latest commit-id will be fetched when 
 > saving the next file.  
 > 
-> // Or
-> 
-> gist.save();
->
+> Or
+```ts
+gist.save();
+```
 > this will work as well because all the changes will go in a single commit.
-> 
+
 
 ## Installation
 
@@ -166,3 +173,49 @@ await projectsFile.save();
 await gist.save();
 ```
 > Only files that have un-saved changes will be saved.
+
+### Sample
+```ts
+import GithubGist from "./src";
+
+const personalAccessToken = "";
+
+const githubGist = new GithubGist({
+  appIdentifier: 'MyTestApp',
+  personalAccessToken,
+  cors: {
+    addPrefix: true,
+    customPrefix: (someURl) => `YourCustomPrefix` + someURl,
+  },
+});
+
+(async () => {
+  await githubGist.touch();
+
+  console.log("Gist ID", githubGist.id);
+  console.log("Github Username", githubGist.ownerUsername);
+
+  console.log("Original File names", githubGist.getFileNames());
+
+  const created = githubGist.createFile("projects.json", "{}");
+  if (created) {
+    console.log('Created new file in gist');
+  } else {
+    console.log('Updated existing file in gist');
+  }
+
+  // Note: All the creates and updates happen in-memory. You have to
+  // explicitly invoke the `save` method on either the entire gist instance
+  // or the individual file instance.
+
+  // Saves all the files in the gist. Only the un-saved changes will be
+  // added to the payload.
+  await githubGist.save();
+
+  // Save individual file.
+  // const file = githubGist.getFile('projects.json');
+  // await file.save();
+
+  console.log("File names", githubGist.getFileNames());
+})();
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-github-gist-api",
-  "version": "2.0.0",
+  "version": "2.0.4",
   "description": "A way to store data on Github Gist.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,7 +14,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com:rv-npm/simple-github-gist-api.git"
+    "url": "git+ssh://git@github.com:vighnesh153/simple-github-gist-api.git"
   },
   "keywords": [
     "gist",
@@ -27,9 +27,9 @@
   "author": "Vighnesh Raut",
   "license": "GPL-3.0-or-later",
   "bugs": {
-    "url": "https://github.com/rv-npm/simple-github-gist-api/issues"
+    "url": "https://github.com/vighnesh153/simple-github-gist-api/issues"
   },
-  "homepage": "https://github.com/rv-npm/simple-github-gist-api#readme",
+  "homepage": "https://github.com/vighnesh153/simple-github-gist-api#readme",
   "devDependencies": {
     "@types/jest": "^27.0.2",
     "jest": "^27.3.0",