docs: add planned features and rewrite features#47
Merged
caped-doshi merged 1 commit intomainfrom Aug 28, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README documentation to improve clarity and add visibility to upcoming functionality. The changes rewrite the features section to be more descriptive and user-focused, while also adding a new planned features section.
Key changes:
- Rewrote the features section with detailed descriptions emphasizing user capabilities
- Added a "Planned Features" section documenting websocket data recording and inverse perpetual support
- Removed an FAQ link from the documentation section
Comments suppressed due to low confidence (1)
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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
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.
Rewrote the features to emphasize the capabilities for the user. Also include planned features, such as websocket listening and support for inverse perpetuals.