fix(Constants): typo

chore(docs): update docs chore(README.md): update readme.md
SiruBOT · Aug 30, 2022 · 6b7752d · 6b7752d
1 parent 2c40909
commit 6b7752d
Show file tree

Hide file tree

Showing 18 changed files with 58 additions and 69 deletions.
diff --git a/README.md b/README.md
@@ -1,19 +1,23 @@
-# slyrics - Fetch Lyrics Without Api Key
+<h1 align="center">🗒️  slyrics - Fetch Lyrics Without Api Key</h1>
 
-## Installation
-Using npm:
-```
+<p align="center">
+  <a href="https://www.npmjs.com/package/slyrics">
+    <img alt="slyrics version" src="https://badge.fury.io/js/slyrics.svg"></img>
+  </a>
+<p>
+
+
+## 📥  Installation
+``
 npm install slyrics --save
-```
-Using yarn:
-```
-yarn add slyrics
-```
+``   
+or   
+``yarn add slyrics``
 
-## Documentation
-[Typedoc](https://sirubot.github.io/slyrics/)
+## [Documentation](https://slyrics.cocochino.cafe)
+[![pages-build-deployment](https://github.com/SiruBOT/slyrics/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/SiruBOT/slyrics/actions/workflows/pages/pages-build-deployment)
 
-## Typescript Example
+## Example Code
 ```ts
 import { ILyricsSearchResult } from "./interfaces";
 import { Lyrics } from "./structures";
@@ -24,18 +28,17 @@ async function example() {
   const res: ILyricsSearchResult = await provider.search("RE:WIND");
   if (res.entries.length === 0) {
     console.log("No result");
-  } else {
-    const lyricsInstance: Lyrics = await res.entries[0].getLyrics();
-    console.log(
-      `${res.entries.length} results found.\nFirst one: ${lyricsInstance.title} - ${lyricsInstance.artist}
-${lyricsInstance.lyrics}`
-    );
+    return;
   }
+  const lyricsInstance: Lyrics = await res.entries[0].getLyrics();
+  console.log(res.entires.length + " results");
+  console.log("First entry: " + lyricsInstance.title + " - " + lyricsInstance.artist);
+  console.log(lyricsInstance.lyrics);
 }
 
 example();
 ```
 
 |Provider|tag|Contributor|
 |------|---|---|
-|Melon|melon|Sangoon_Is_Noob|
+|Melon|melon|[Sannoob3144](https://github.com/sannoob3144)|
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -1,10 +1,10 @@
 :root {
-    --light-hl-0: #001080;
-    --dark-hl-0: #9CDCFE;
+    --light-hl-0: #AF00DB;
+    --dark-hl-0: #C586C0;
     --light-hl-1: #000000;
     --dark-hl-1: #D4D4D4;
-    --light-hl-2: #AF00DB;
-    --dark-hl-2: #C586C0;
+    --light-hl-2: #001080;
+    --dark-hl-2: #9CDCFE;
     --light-hl-3: #A31515;
     --dark-hl-3: #CE9178;
     --light-hl-4: #0000FF;
@@ -17,10 +17,6 @@
     --dark-hl-7: #4EC9B0;
     --light-hl-8: #098658;
     --dark-hl-8: #B5CEA8;
-    --light-hl-9: #000000FF;
-    --dark-hl-9: #D4D4D4;
-    --light-hl-10: #EE0000;
-    --dark-hl-10: #D7BA7D;
     --light-code-background: #F5F5F5;
     --dark-code-background: #1E1E1E;
 }
@@ -35,8 +31,6 @@
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
     --hl-8: var(--light-hl-8);
-    --hl-9: var(--light-hl-9);
-    --hl-10: var(--light-hl-10);
     --code-background: var(--light-code-background);
 } }
 
@@ -50,8 +44,6 @@
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
     --hl-8: var(--dark-hl-8);
-    --hl-9: var(--dark-hl-9);
-    --hl-10: var(--dark-hl-10);
     --code-background: var(--dark-code-background);
 } }
 
@@ -65,8 +57,6 @@ body.light {
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
     --hl-8: var(--light-hl-8);
-    --hl-9: var(--light-hl-9);
-    --hl-10: var(--light-hl-10);
     --code-background: var(--light-code-background);
 }
 
@@ -80,8 +70,6 @@ body.dark {
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
     --hl-8: var(--dark-hl-8);
-    --hl-9: var(--dark-hl-9);
-    --hl-10: var(--dark-hl-10);
     --code-background: var(--dark-code-background);
 }
 
@@ -94,6 +82,4 @@ body.dark {
 .hl-6 { color: var(--hl-6); }
 .hl-7 { color: var(--hl-7); }
 .hl-8 { color: var(--hl-8); }
-.hl-9 { color: var(--hl-9); }
-.hl-10 { color: var(--hl-10); }
 pre, code { background: var(--code-background); }
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/BaseProvider.html b/docs/classes/BaseProvider.html
diff --git a/docs/classes/HTTPRequester.html b/docs/classes/HTTPRequester.html
diff --git a/docs/classes/Lyrics.html b/docs/classes/Lyrics.html
diff --git a/docs/classes/LyricsSearchResultItem.html b/docs/classes/LyricsSearchResultItem.html
diff --git a/docs/classes/MelonProvider.html b/docs/classes/MelonProvider.html
diff --git a/docs/classes/SLyricsHTTPRequestError.html b/docs/classes/SLyricsHTTPRequestError.html
diff --git a/docs/classes/SLyricsNotImplementedError.html b/docs/classes/SLyricsNotImplementedError.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/ILyrics.html b/docs/interfaces/ILyrics.html
diff --git a/docs/interfaces/ILyricsSearchResult.html b/docs/interfaces/ILyricsSearchResult.html
diff --git a/docs/interfaces/ILyricsSearchResultItem.html b/docs/interfaces/ILyricsSearchResultItem.html
diff --git a/docs/interfaces/IProvider.html b/docs/interfaces/IProvider.html
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "slyrics",
-  "version": "1.0.2",
+  "version": "1.0.21",
   "description": "Scrape Lyrics without API Key",
   "main": "dist/index.js",
   "scripts": {

diff --git a/src/Constances.ts → src/Constants.ts b/src/Constances.ts → src/Constants.ts
diff --git a/src/structures/BaseProvider.ts b/src/structures/BaseProvider.ts
@@ -1,7 +1,7 @@
 import { SLyricsNotImplementedError } from "../errors/SLyricsNotImplementedError";
 import { IProvider } from "../interfaces/IProvider";
 import { ILyricsSearchResult } from "../interfaces/ILyricsSearchResult";
-import { NotImplCodes } from "../Constances";
+import { NotImplCodes } from "../Constants";
 export abstract class BaseProvider implements IProvider {
   public name: string;
   constructor(name: string) {