Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Spiff up the Readme #146

Closed
2 of 5 tasks
rigelrozanski opened this issue Jun 29, 2017 · 6 comments · Fixed by #236
Closed
2 of 5 tasks

Spiff up the Readme #146

rigelrozanski opened this issue Jun 29, 2017 · 6 comments · Fixed by #236
Assignees
@rigelrozanski

Comments

@rigelrozanski
Copy link
Contributor

rigelrozanski commented Jun 29, 2017 •
edited by zramsay
Loading

Just Brainstormin'

  • Remove Disclaimer (b/c renamed)
  • Add Coverage and Circle Badges? - as in tendermint
  • Add simple Infographics, maybe link to more complex ones
  • Describe the distinctions between light clients and full nodes, and how they interact
  • More inspiration descriptions
@ethanfrey
Copy link
Contributor

Sounds great!

@ethanfrey
Copy link
Contributor

The more I think, the more this is high priority. As we really get quarks to a state we want people to use, we need to make it catchy.

How about a little quarks logo on the top as well. Overview, links to more details, example apps, etc... The infographic is great, as are all diagrams.

And lots of inspiration on what to build, like a links section to "Build with quarks".

We could start this already. I don't want to rename the repo until I am quite sure there are no more changes on the 0.6.x branch, as that makes lots of conflicts in the imports. And I know that 0.6.2 will come out sometime. But we can already rewrite the README in unstable.

@ethanfrey
Copy link
Contributor

Awesome diagrams Rige!

Let's just add a logo and badges and stuff when we rename.

@rigelrozanski
Copy link
Contributor Author

@zramsay

@zramsay zramsay mentioned this issue Aug 23, 2017
Merged
@zramsay
Copy link
Contributor

zramsay commented Aug 23, 2017

tackled a bunch in #236, IMO the remaining points should be handled in the docs

ethanfrey pushed a commit that referenced this issue Aug 25, 2017
@zramsay @ethanfrey
spiff up readme, #146
1408eb6
@ethanfrey
Copy link
Contributor

Will close as soon as I make a few minor. Changes

@zramsay zramsay removed their assignment Aug 27, 2017
@zramsay zramsay closed this as completed Oct 11, 2017
@snyk-bot snyk-bot mentioned this issue Dec 23, 2020
Open
This was referenced Sep 6, 2021
Closed
Open
@snyk-bot snyk-bot mentioned this issue Jan 10, 2022
Open
alexanderbez pushed a commit that referenced this issue Apr 5, 2022
@p0mvn @ValarDragon
extra logs during commit (#146)
7bd7a32 
* add extra logs during commit

* Update store/rootmulti/store.go

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>
@terrorizer1980 terrorizer1980 mentioned this issue Nov 5, 2022
Closed
@snyk-bot snyk-bot mentioned this issue Nov 5, 2022
Open
@terrorizer1980 terrorizer1980 mentioned this issue Dec 26, 2022
Closed
@dgpatelgit dgpatelgit mentioned this issue Dec 26, 2022
Open
@terrorizer1980 terrorizer1980 mentioned this issue Jan 2, 2024
Closed
@dgpatelgit dgpatelgit mentioned this issue Jan 2, 2024
Open
@terrorizer1980 terrorizer1980 mentioned this issue Mar 15, 2024
Closed
@dgpatelgit dgpatelgit mentioned this issue Mar 15, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rigelrozanski rigelrozanski

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

spiff up readme
3 participants
@ethanfrey @zramsay @rigelrozanski