followme v0.0.2

Synopsis

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

TODO: explain what this module is for.

Current version

The current version is a skeleton that does nothing.

TODO's

Basically everything right now. I just liked the name & I didn't want someone else to take it first. (I am currently working on the implementation, though.)

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. TODO: provide examples

Motivation

Because I really want my shell's behavior to change as I navigate to different places in my file system.

Installation

npm i -g followme

TODO: complete

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. TODO: explain API or lack thereof

Tests

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

Contributors

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

License

MIT licensed