Skip to content

Instantly share code, notes, and snippets.

@ay589
Forked from akashnimare/README.md
Created December 5, 2017 19:56
Show Gist options
  • Save ay589/6d4085f6e763fd3c2553429c500419c3 to your computer and use it in GitHub Desktop.
Save ay589/6d4085f6e763fd3c2553429c500419c3 to your computer and use it in GitHub Desktop.

Revisions

  1. @akashnimare akashnimare revised this gist Nov 23, 2016. 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
    @@ -53,6 +53,6 @@ Give proper credits. This could be a link to any repo which inspired you to buil
    #### Anything else that seems useful

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

    MIT © [Yourname]()
  2. @akashnimare akashnimare revised this gist Nov 23, 2016. 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
    @@ -53,6 +53,6 @@ Give proper credits. This could be a link to any repo which inspired you to buil
    #### Anything else that seems useful

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

    MIT © [Yourname]()
  3. @akashnimare akashnimare created this gist Sep 19, 2016.
    58 changes: 58 additions & 0 deletions README.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,58 @@
    ## Project title
    A little info about your project and/ or overview that explains **what** the project is about.

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

    ## Build status
    Build status of continus integration i.e. travis, appveyor etc. Ex. -

    [![Build Status](https://travis-ci.org/akashnimare/foco.svg?branch=master)](https://travis-ci.org/akashnimare/foco)
    [![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/akashnimare/foco?branch=master&svg=true)](https://ci.appveyor.com/project/akashnimare/foco/branch/master)

    ## Code style
    If you're using any code style like xo, standard etc. That will help others while contributing to your project. Ex. -

    [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

    ## Screenshots
    Include logo/demo screenshot etc.

    ## Tech/framework used
    Ex. -

    <b>Built with</b>
    - [Electron](https://electron.atom.io)

    ## Features
    What makes your project stand out?

    ## 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.

    ## Installation
    Provide step by step series of examples and explanations about how to get a development env running.

    ## 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.

    ## How to use?
    If people like your project they’ll want to learn how they can use it. To do so include step by step guide to use your project.

    ## Contribute

    Let people know how they can contribute into your project. A [contributing guideline](https://github.com/zulip/zulip-electron/blob/master/CONTRIBUTING.md) will be a big plus.

    ## Credits
    Give proper credits. This could be a link to any repo which inspired you to build this project, any blogposts or links to people who contrbuted in this project.

    #### Anything else that seems useful

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

    MIT © [Yourname]()