Browse Source

docs: random stuff

Sv443 4 months ago
parent
commit
29814fe6d0
3 changed files with 6 additions and 5 deletions
  1. 1 1
      www/.vuepress/configs/sidebar/en.ts
  2. 4 3
      www/docs/README.md
  3. 1 1
      www/docs/routes/README.md

+ 1 - 1
www/.vuepress/configs/sidebar/en.ts

@@ -3,7 +3,7 @@ import type { SidebarOptions } from "@vuepress/theme-default";
 export const sidebarEn: SidebarOptions = {
   "/docs/": [
     {
-      text: "Getting started",
+      text: "Introduction",
       link: "/docs/README.md",
     },
     {

+ 4 - 3
www/docs/README.md

@@ -1,10 +1,11 @@
 ---
 lang: en-US
-title: Guide
+title: Introduction
 description: Get started with using geniURL to fetch lyrics metadata
 ---
 
-## Introduction
 geniURL is a simple JSON and XML REST API to search for song metadata, the lyrics URL and lyrics translations on genius.com.  
 Authorization is not required and geniURL implements a fuzzy search that will greatly improve search results over the genius.com API.  
-Obtaining actual lyrics sadly isn't possible.
+Obtaining actual lyrics sadly isn't possible.  
+  
+Please [refer to the routes section](./routes/) for more information.

+ 1 - 1
www/docs/routes/README.md

@@ -15,7 +15,7 @@ https://api.sv443.net/geniurl/v2/
 ## Rate Limiting
 The public instance is rate limited to 25 requests within a 30 second timeframe.  
 To know how many requests you have sent and are still able to send, refer to the following headers that are attached to each response:
-| Name                    | Description                                                                                                     |
+| Header Name             | Description                                                                                                     |
 | :---------------------- | :-------------------------------------------------------------------------------------------------------------- |
 | `Retry-After`           | Number of seconds you need to wait until being able to send another request.                                    |
 | `X-RateLimit-Reset`     | An [ISO 8601 UTC timestamp](https://en.wikipedia.org/wiki/ISO_8601) indicating when you can send more requests. |