Readme Polish + License #1
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DanStough
commented
Apr 17, 2025
| @@ -0,0 +1,21 @@ | |||
| MIT License | |||
There was a problem hiding this comment.
Used MIT because all the SDKs are licensed that way.
DanStough
commented
Apr 17, 2025
| This command will install the MCP server in your current project. | ||
| If you want to install it globally, you can run the command with `-s <scope>` flag. | ||
| See `claude mcp add --help` for more options. |
There was a problem hiding this comment.
By default the MCP is added to local, which for claude is the very literal path you were at when you ran the command. I think this is why it didn't work when you moved directories.
TIL: you can find this config at ~/.claude.json
DanStough
commented
Apr 17, 2025
Comment on lines
-69
to
-74
| ## Configuration | ||
|
|
||
| ### Environment Variables | ||
|
|
||
| - `POLYGON_API_KEY` (required): Your Polygon.io API key | ||
|
|
There was a problem hiding this comment.
I made a few edits like this just to make things more concise.
DanStough
commented
Apr 17, 2025
Comment on lines
+143
to
+145
| ## Contributing | ||
| If you found a bug or have an idea for a new feature, please first discuss it with us by submitting a new issue. | ||
| We will respond to issues within at most 3 weeks. | ||
| We're also open to volunteers if you want to submit a PR for any open issues but please discuss it with us beforehand. | ||
| PRs that aren't linked to an existing issue or discussed with us ahead of time will generally be declined. |
There was a problem hiding this comment.
Also borrowed from the SDK readmes
DanStough
commented
Apr 17, 2025
| ], | ||
| "env": { | ||
| "POLYGON_API_KEY": "<your_api_key_here>", | ||
| "HOME": "<your_home_directory>" |
There was a problem hiding this comment.
I think this was only needed because the repo is private, so we might be able to remove later.
DanStough
commented
Apr 17, 2025
6866eb2 to
c5ae472
Compare
joedursun
approved these changes
Apr 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Some minor edits + the Claude Desktop config we talked about. Some comments inline below.