Proposal for a README #1
Merged
Conversation
This file contains 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
campoy
approved these changes
Aug 20, 2018
README.md
Outdated
|
|
||
| ``` | ||
| # Without a path it operates on the local folder, | ||
| # it works with nested folder. |
| srcd sql | ||
| ``` | ||
|
|
||
| This will open a SQL client that allows you to execute queries against your repositories. |
There was a problem hiding this comment.
I'd mention that you can also run the requests directly from the command line: srcd sql "show tables;"
| ## Contributing | ||
|
|
||
| Contributions are **welcome and very much appreciated** 🙌 | ||
| Please refer [to our contribution guide](CONTRIBUTING.md) for more details. |
There was a problem hiding this comment.
By design, there are placeholders here, for you to add. I felt you should be writing the contributing guide (editing/adding to our template that can be found in the guide).
|
Note for maintainer:
|
|
@campoy if you like the idea as well, I added a badge to link to our design document. I suggest we do this on all of our projects that have a design doc. |
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.
Since the engine-cli will be the entry point for many users, I was thinking, so should be the repository, Therefore I've written a README based upon the excellent structure of prisma. Some of the content is still placeholder and will need to be filled out further.