Application and amd tools source code for The Sentient Well public Sandbox can be found here.

Badges will go here

• build status
• issues (waffle.io maybe)
• devDependencies
• npm package
• coverage
• slack
• downloads
• gitter chat
• license
• etc.

• For more on these wonderful badgers badges, refer to badgerbadgerbadger.

INSERT ANOTHER GRAPHIC HERE

• Most people will glance at your README, maybe star it, and leave
• Ergo, people should understand instantly what your project is about based on your repo

Tips

• HAVE WHITE SPACE
• MAKE IT PRETTY
• GIFS ARE REALLY COOL

GIF Tools

• Use Recordit to create quicks screencasts of your desktop and export them as GIFs.
• For terminal sessions, there's ttystudio which also supports exporting GIFs.

Recordit

ttystudio

If you're README has a lot of info, section headers might be nice.

• Installation
• Features
• Contributing
• Team
• FAQ
• Support
• License

Example of inline code linking (javascript)

// code away!

let generateProject = project => {
  let code = [];
  for (let js = 0; js < project.length; js++) {
    code.push(js);
  }
};

• For all the possible languages that support syntax highlithing on GitHub (which is basically all of them), refer here.

• All the code required to get started
• Images of what it should look like

• Instrucitons to clone this Repo to your sysem.

• If you want more syntax highlighting, format your code like this:

Example of inline code linking (shell)

$ npm install
$ bower install

• For all the possible languages that support syntax highlithing on GitHub (which is basically all of them), refer here.

• Going into more detail on code and technologies used
• I utilized this nifty Markdown Cheatsheet for this sample README.

To get started...

• All neccessary installaiton and setup instrucitons/documents will be linked here as required.

• Contributors to projects and code will highlighted as required.

• Documents will be posted as required.

Contact Options

• Website at www.SentientWell.com
• Twitter at @SentientWell
• Insert more social links here.

• MIT license
• Copyright 2015 © SentientWell.