docs(readme): refactor readme & install script #49
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
Signed-off-by: Ajam <AjamX101@gmail.com>
Signed-off-by: Ajam <AjamX101@gmail.com>
Signed-off-by: Ajam <AjamX101@gmail.com>
Signed-off-by: Ajam <AjamX101@gmail.com>
Signed-off-by: Ajam <AjamX101@gmail.com>
Signed-off-by: Ajam <AjamX101@gmail.com>
Signed-off-by: Ajam <AjamX101@gmail.com>
Azathothas
changed the title
Member
Author
|
What's the hold up here, why is this still not merged? |
Merged
github-actions bot
pushed a commit
to Azathothas/soar
that referenced
this pull request
May 13, 2025
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Installation moved to top
It was a pain to scroll down, only to be told to go another page to get the one liner cmd.
This was moved directly to top and reduces friction. This is also how other major projects do it: Show, don't tell
Removed redundant stuff, which only sent the user to the docs
Fixed the gif
Made the caveats a table and clarified a few more things
Other changes
make sure to spellcheck, my keyboard is broken as usual.