Skip to content
This repository has been archived by the owner on Jan 15, 2019. It is now read-only.

Commit

Permalink
Update README badge and some content
Browse files Browse the repository at this point in the history
  • Loading branch information
Christian Gaetano committed May 5, 2017
1 parent 87e57fc commit 66daa72
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Simple and fast caching tool for tracking file changes on [node](https://nodejs.org/).

[![npm version](https://badge.fury.io/js/impostr@2x.png)](https://badge.fury.io/js/impostr)
[![npm version](https://badge.fury.io/js/impostr.svg)](https://badge.fury.io/js/impostr)

```javascript
var impostr = require('impostr');
Expand Down Expand Up @@ -31,7 +31,7 @@ Here's what you'll need installed on your development machine:
- [Yarn](https://yarnpkg.com/en/) (Optional but recommended - see [below](#installation).)
- [Git](https://git-scm.com/)

### Installation
### Initializing Environment

The first step in installing the API for local testing is cloning the code from the Git repository:

Expand All @@ -56,15 +56,15 @@ Our Gulp pipeline is linked with a NPM script, so all you need to do to build th

You can also run Gulp build tasks individually if you'd like. The primary Gulp build task can be started with `gulp build`. A more detailed listing of Gulp build tasks will be in this section soon!

## Source Code Guidelines
### Source Code Guidelines

In general, this project follows a traditional Node.js project structure and uses some well-established code style and source control guidelines. Be sure any code you submit for inclusion in the project conforms to these guidelines!

### File structure
#### File structure

All source code is written in ES2015 JavaScript and goes in `src/`. Our build pipeline transpiles this code to ES5 specific to your current Node version and places it in `build/`.

### Code Style
#### Code Style

All JavaScript code is checked for syntax and API standards according to the [airbnb JavaScript style guide](https://github.com/airbnb/javascript). Specifically, we use [ESLint](http://eslint.org/) and the [eslint-config-airbnb-base](https://www.npmjs.com/package/eslint-config-airbnb-base) package for code linting.

Expand All @@ -82,17 +82,22 @@ We're definitely open to making modifications to our style guidelines. In fact,

The best way to get the rules changed is by simply breaking them! Submit a pull request with code that doesn't pass linting via `yarn run lint` and explain why you think it should. If we can come to a consensus, we'll modify our rules accordingly.

### Source Control
#### Source Control

We use Git for source control and the [Gitflow methodology](http://nvie.com/posts/a-successful-git-branching-model/) for managing branching, pull requests, and releases.

## Tests

Right now, there's just a rudimentary test set up in `/test`. Official and _useful_ unit testing **coming soon**!

## Roadmap

Upcoming changes:

_(In order of priority)_

- Coming soon
- Unit testing
- Support for more file metadata - date changed, changed by, etc.

## License

Expand All @@ -102,7 +107,7 @@ This project is licensed under the [MIT license](LICENSE).

Huge thanks to this team of direct contributors for writing the code!

- Your name could be here! :)
- [Your name could be here!](#contributing) :)
- [Christian Gaetano](http://christiangaetano.com)

## Built With
Expand All @@ -116,4 +121,5 @@ _(In alphabetical order to avoid favoritism)_ 😉
- [ESLint](http://eslint.org/)
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en/)
- [rev-hash](https://www.npmjs.com/package/rev-hash)
- [Yarn](https://yarnpkg.com/en/)

0 comments on commit 66daa72

Please sign in to comment.