feat: update readme with demo gif and information about project#304
Merged
cguedes merged 14 commits intoJul 17, 2023
Merged
Conversation
- Sample image (will upgraded to a GIF) - Adds a section with Prerequisites - rewrite setup & run section
Contributor
|
Thanks, this looks good as a definite improvement! I can tweak the text a bit after it goes in. I also think we need to include Rust in the prerequisites. Maybe something like: |
Codecov Report
@@ Coverage Diff @@
## main #304 +/- ##
==========================================
+ Coverage 86.33% 87.60% +1.27%
==========================================
Files 135 12 -123
Lines 7528 799 -6729
Branches 823 0 -823
==========================================
- Hits 6499 700 -5799
+ Misses 1016 99 -917
+ Partials 13 0 -13 see 123 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Contributor
|
Good to merge? |
Collaborator
Author
|
I’m trying to get a short GIF now that we have the completion command merged. But we can merge this and I can create another PR only for that. |
…ion-about-project
This reverts commit f006815.
sehyod
reviewed
Jul 17, 2023
sehyod
approved these changes
Jul 17, 2023
cguedes
deleted the
160-update-readme-with-demo-gif-and-information-about-project
branch
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
3 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.
This closes #160
The PR adds:
The new README is available here.