feat: added contribute section + api endpoints comments (#16)

ilkamo · Jun 4, 2024 · 6efe99d · 6efe99d
1 parent f3630e3
commit 6efe99d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -219,15 +219,17 @@ WaitForCommitmentStatus(
 ) (MonitorResponse, error)
 ```
 
-## API Urls
+## API URLs
 
 This library provides two options to leverage for Jupiter APIs. 
 
 The default Jupiter API provided by the official Jupiter team can be used via `jupiter.DefaultAPIURL`.
 
 The second Jupiter API option leverages [jupiterapi.com](https://www.jupiterapi.com/) (Community Project). This endpoint provides higher rate limits, but *includes a small 0.2% platform fee*. This API can be used via `jupiter.JupiterAPIURL`.
 
+## Contribute
 
+Contributions are welcome! Feel free to open an issue or submit a pull request if you find a bug or want to add a new feature.
 
 ## License
 

diff --git a/jupiter/api.go b/jupiter/api.go
@@ -1,4 +1,9 @@
 package jupiter
 
-const DefaultAPIURL = "https://quote-api.jup.ag/v6"
-const JupiterAPIURL = "https://public.jupiterapi.com"
+const (
+	// DefaultAPIURL is the default Jupiter API provided by the official Jupiter team.
+	DefaultAPIURL = "https://quote-api.jup.ag/v6"
+
+	// JupiterAPIURL provides higher rate limits, but includes a small 0.2% platform fee.
+	JupiterAPIURL = "https://public.jupiterapi.com"
+)