Skip to content
Examples of how to create a great readme file
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
LICENSE
README.md

README.md

Project Logo

Readme.md file example and assets

This repository is an example for a good public repository README page, and is here to provide you with ideas and assets to use in your readme files. Readme file are critical for helping your users understand what you are offering, and helps make your repository appear more professional, well maintained, useful, and easy to use. You don't have to use all the elements on this readme, but the more information you provide in your readme file, the better.

*Note - There is a difference between the 'Read me' page of your public repository and the private one, according to the monetization path you chose. Make sure to use your public readme file to send users to your xscode repository page, with an explenation on how you monetize your code.

Monetization model

Make sure to include an explantion on how you monetize your repository, and how your paid version is different than the one offered for free on Github. Use one of these assets and texts in your readme.md file, to help your users get started quickly.

Starting from version 0.0.0.0, this project is licensed under the GPLv3 license. For a MIT licensed version, visit xs:code


This project is offered as open-core, with the following extra features available on xs:code:

  • Multi language support
  • Framework compatibility
  • Monthly updates
  • Extra modules
  • Etc.

Subscribe to this project on xs:code and get 5 monthly support hours.






Static Code Analysis

Make it easy for users to see the project progress and other indicators, Check out Shields.io to use or make your own badges.

For added visibility, add our badge, and change the URL to direct to your repository URL on xs:code.

Additionally, use these other badge options to provide more information about your project:

version build contributors coverage backers downloads dependencies code analysis grade rating Gitter Twitter Follow Subreddit subscribers

Table of Contents

You can include a table of contents in order to allow other developers to navigate your readme file.

(especially if you have a long and detailed README).

Demo / Demo GIF

Make a GIF with any GIF maker / screen recorder and show users how your project works.

Demo GIF

via @Beedigital.net on GIPHY

Check out the Demo (Add a real link to your demo version)

Prerequisites

State the prerequisites needed to use or install your project.

System Requirements:

Installation

Step by step instullation explanation, or a quick introduction of the minimal setup you need to get a hello world up & running.

packagemanager install Public-README-Sample
Public-README-Sample start
Public-README-Samplet "Help mw promote my repo!"  # prints "YES."

Here you should say what actually happens when you execute the code above.

Initial Configuration

Some projects require initial configuration (e.g. access tokens or keys, npm i). This is the section where you would document those requirements.

Usage

Instruct developers on how to use your project after they’ve installed it. This would also be a good place to include screenshots of your project in action.

screenshot

Running tests

Explain how to run the automated tests for this project

Tests example

Built With

If your project needs some additional steps for the developer to build the project after some code changes, state them here:

./configure
make
make install

Documentaion

Add a link to your Documentation. It's important to have a detailed and current documentation of your project. Check out this great and easy documentaion tool - docusaurus.io for easily creating documentation for your project.

What's Included? (Features)

Add a list of the features included in the project.

  • The main functionality of this project
  • Does another thing
  • Also do this - Available only in the licensed version at xs:code
  • And more - Available only in the licensed version at xs:code

*Note - Some features are only available in paid version at xs:code

Contributing

Contributions are always welcome! If you'd like to contribute, please read our [contributors guidelines], fork the repository and use a feature branch.

IMPORTANT! Before contributions can be accepted, please fill and sign a CLA, and send it to my@email.com. Contributions without a signed CLA cannot be accepted. Find a CLA here:

*Note - Add a link to 'CONTRIBUTING.md' file for deatils on your code of conduct, and the process for submitting pull requests to you.

Support & Maintenance

*Note - Support & Maintenance are only available in the Premmisive MIT license version at xs:code

Contributors

A Huge thank you to all our contributors for maintaining and supporting this project.

Dekel Kan
Dekel Kan

💻
Chen Ravid
Chen Ravid

💻
Netnael Mohoni
Netnael Mohoni

💻
Elad Adir
Elad Adir

💻

*Note - You can also use the Emoji Key and all-contributors bot to automate acknowledging contributors to your projects.

Author

This repository was made with 💙 by xs:code

Licensing

This project is licensed under the MIT license.

You can’t perform that action at this time.