Short blurb about what your product does.
One to two paragraph statement about your product and what it does.
OS X & Linux:
npm install my-crazy-module --saveWindows:
edit autoexec.bat'''c# class Program {
static void Main(string[] args)
{
ConsoleOutput co = new ConsoleOutput();
co.Write("test");
IOutput iout = co;
TodayWriter tw = new TodayWriter( co);
tw.WriteDate();
Console.ReadLine();
}
}
public interface IOutput
{
void Write(string content);
}
public class ConsoleOutput : IOutput
{
public void Write(string content)
{
Console.WriteLine(content);
}
}
public interface IDateWriter
{
void WriteDate();
}
public class TodayWriter : IDateWriter
{
private IOutput _output;
public TodayWriter(IOutput output)
{
this._output = output;
}
public void WriteDate()
{
this._output.Write(DateTime.Today.ToShortDateString());
}
}
'''
Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.
make install
npm test- 0.2.1
- CHANGE: Update docs (module code remains unchanged)
- 0.2.0
- CHANGE: Remove
setDefaultXYZ() - ADD: Add
init()
- CHANGE: Remove
- 0.1.1
- FIX: Crash when calling
baz()(Thanks @GenerousContributorName!)
- FIX: Crash when calling
- 0.1.0
- The first proper release
- CHANGE: Rename
foo()tobar()
- 0.0.1
- Work in progress
Your Name – @YourTwitter – YourEmail@example.com
Distributed under the XYZ license. See LICENSE for more information.
https://github.com/yourname/github-link
- Fork it (https://github.com/yourname/yourproject/fork)
- Create your feature branch (
git checkout -b feature/fooBar) - Commit your changes (
git commit -am 'Add some fooBar') - Push to the branch (
git push origin feature/fooBar) - Create a new Pull Request
