Added usage.md and wrote getSearchSuggestions

README.md

@@ -21,24 +21,6 @@ Because of this, I decided to build my own version of a youtube music api with T
     -   Albums
     -   Playlists
 
-### Methods to fetch data
-
-#### `getSearchSuggestions`
-
-This function takes in the following parameters
-
-| Name  | Data Type | Description                           |
-| :---- | :-------- | :------------------------------------ |
-| query | `string`  | Search query you want suggestions for |
-
-The function returns a `Promise<string[]>` which are the suggestion results
-
-```ts
-ytmusic.getSearchSuggestions("Lilac").then(res => {
-	console.log(res)
-})
-```
-
 #### `search`
 
 This function takes in the following parameters

docs/.vuepress/config.ts

@@ -19,6 +19,10 @@ export default defineUserConfig<DefaultThemeOptions>({
 						text: "Getting Started",
 						link: "/docs/getting-started.html"
 					},
+					{
+						text: "Usage",
+						link: "/docs/usage.html"
+					},
 					{
 						text: "References",
 						link: "/docs/references.html"

docs/docs/references.md

@@ -4,6 +4,24 @@
 
 ### `getSearchSuggestions`
 
+::: tip Properties
+
+| Name    | Data Type | Description                           |
+| :------ | :-------- | :------------------------------------ |
+| `query` | `string`  | Search query you want suggestions for |
+
+:::
+
+::: tip Returns
+
+`Promise<string[]>`
+
+:::
+
+```ts
+public async getSearchSuggestions(query: string): Promise<string[]>
+```
+
 ### `search`
 
 ### `getSong`

docs/docs/usage.md

@@ -0,0 +1,49 @@
+# Usage
+
+YTMusic provides you many ways of fetching data from YouTube Music<br />
+To leverage all the functions, we will need to create an instance of the class `YTMusic`.
+Then, call the `initialize()` to initialize the API before using the API anywhere
+
+```ts
+const ytmusic = new YTMusic()
+ytmusic.initialize().then(() => {
+	// Use API here
+})
+```
+
+## `getSearchSuggestions` function
+
+`getSearchSuggestions()` will fetch you a list of search suggestions based on the query
+
+```ts
+ytmusic.getSearchSuggestions("Lilac").then(res => {
+	console.log(res)
+})
+// > [
+// >     "lilac",
+// >     "lilac iu",
+// >     "lilac band",
+// >     "lilac wine",
+// >     "lilac wine miley cyrus",
+// >     "lilac close my eyes forever",
+// >     "lilac holy diver"
+// > ]
+```
+
+## `search` function
+
+## `getSong` function
+
+## `getVideo` function
+
+## `getArtist` function
+
+## `getArtistVideo` function
+
+## `getArtistAlbums` function
+
+## `getAlbum` function
+
+## `getPlaylist` function
+
+## `getPlaylistVideos` function