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.

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

Add example IPFS README #235

Merged
merged 1 commit into from
Feb 9, 2017
Merged

Add example IPFS README #235

merged 1 commit into from
Feb 9, 2017

Conversation

RichardLitt
Copy link
Member

This adds an example IPFS README that conforms to standard-readme and should be able to help with making new READMEs for IPFS repositories. It is language agnostic. However, it is based on a request by the JS team (specifically, @diasdavid) in #225 (comment)

This adds an example IPFS README that conforms to standard-readme and should be able to help with making new READMEs for IPFS repositories. It is language agnostic. However, it is based on a request by the JS team (specifically, @diasdavid) in #225 (comment)
@daviddias
Copy link
Member

When you say that I requested, you mean this:

It would be great to have a section for the badges that we always put in every repo

?

If yes, I was more thinking of just having a 'section' on the js guidelines (single doc) with the list of badges. I don't believe that having a full readme-template is a good idea since you already built a tool that scaffolds it, it might be just a lot of work to keep everything in sync.

@RichardLitt
Copy link
Member Author

Ah. This should be the source of truth for IPFS repos - the tool for scaffolding works for standard-readmes but for IPFS readmes (which have some additions to standard-readme) should follow this template. We're not going to use ipfs/devtools anymore, so I am putting this here for now.

I don't think there are any JavaScript specific badges. I might be wrong here. Let me know if I am.

@RichardLitt RichardLitt merged commit 9beada7 into master Feb 9, 2017
@RichardLitt RichardLitt deleted the feat/add-readme-example branch February 9, 2017 14:57
@RichardLitt RichardLitt removed the status/in-progress In progress label Feb 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants