Skip to content

Instantly share code, notes, and snippets.

@shri3k
Forked from jxson/README.md
Last active August 29, 2015 14:26
Show Gist options
  • Save shri3k/6284eeb4e7d4b576ada7 to your computer and use it in GitHub Desktop.
Save shri3k/6284eeb4e7d4b576ada7 to your computer and use it in GitHub Desktop.

Revisions

  1. Jason Campbell revised this gist Feb 10, 2012. No changes.
  2. Jason Campbell revised this gist Feb 10, 2012. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion README.md
    Original file line number Diff line number Diff line change
    @@ -1,6 +1,6 @@
    ## Synopsis

    At the top of the file there should be a short introduction and/ or overveiw that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
    At the top of the file there should be a short introduction and/ or overview that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)

    ## Code Example

  3. Jason Campbell created this gist Feb 10, 2012.
    31 changes: 31 additions & 0 deletions README.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,31 @@
    ## Synopsis

    At the top of the file there should be a short introduction and/ or overveiw that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)

    ## Code Example

    Show what the library does as concisely as possible, developers should be able to figure out **how** your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

    ## Motivation

    A short description of the motivation behind the creation and maintenance of the project. This should explain **why** the project exists.

    ## Installation

    Provide code examples and explanations of how to get the project.

    ## API Reference

    Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.

    ## Tests

    Describe and show how to run the tests with code examples.

    ## Contributors

    Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.

    ## License

    A short snippet describing the license (MIT, Apache, etc.)