Skip to content

Commit

Permalink
update readme, license, and contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeff Escalante committed May 13, 2014
1 parent 4b57b94 commit a2bdf3d
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 34 deletions.
30 changes: 30 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing to Axis

Hello there! First of all, thanks for being interested in Axis and helping out. We all think you are awesome, and by contributing to open source projects, you are making the world a better place. That being said, there are a few ways to make the process of contributing code to Axis smoother, detailed below:

### Getting Set Up

- Clone the project down
- Make sure [nodejs](http://nodejs.org) has been installed and is above version `0.10.x`
- Run `npm install`
- Put in work

### Filing Issues

If you are opening an issue about a bug, make sure that you include clear steps for how we can reproduce the problem. If we can't reproduce it, we can't fix it. If you are suggesting a feature, make sure your explanation is clear and detailed.

### Testing

This project is constantly evolving, and to ensure that things are secure and working for everyone, we need to have tests. If you are adding a new feature, please make sure to add a test for it.

To run the test suite, make sure you have installed [mocha](http://visionmedia.github.io/mocha/) (`npm install mocha -g`), then you can use the `npm test` command to run them.

### Code Style

To keep a consistant coding style in the project, we're going with [Felix's Node.js Style Guide](http://nodeguide.com/style.html) for JS and [Polar Mobile's guide](https://github.com/polarmobile/coffeescript-style-guide) for CoffeeScript, but it should be noted that much of this project uses under_scores rather than camelCase for naming. Both of these are pretty standard guides. For documenting in the code, we're using [JSDoc](http://usejsdoc.org/).

### Commit Cleanliness

It's ok if you start out with a bunch of experimentation and your commit log isn't totally clean, but before any pull requests are accepted, we like to have a nice clean commit log. That means [well-written and clear commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) and commits that each do something significant, rather than being typo or bug fixes.

If you submit a pull request that doesn't have a clean commit log, we will ask you to clean it up before we accept. This means being familiar with rebasing - if you are not, [this guide](https://help.github.com/articles/interactive-rebase) by github should help you to get started, and feel free to ask us anything, we are happy to help.
10 changes: 10 additions & 0 deletions license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
License (MIT)
-------------

Copyright (c) 2013 Jeff Escalante

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
51 changes: 17 additions & 34 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,45 @@
Axis CSS
---------

[![NPM version](https://badge.fury.io/js/axis-css.png)](http://badge.fury.io/js/axis-css)
[![Dependency Status](https://david-dm.org/jenius/axis.png)](https://david-dm.org/jenius/axis)
[![npm](https://badge.fury.io/js/axis.png)](http://badge.fury.io/js/axis)
[![tests](https://travis-ci.org/jenius/axis.png?branch=master)](https://travis-ci.org/jenius/axis)
[![dependencies](https://david-dm.org/jenius/axis.png)](https://david-dm.org/jenius/axis)

Axis is a terse, feature-rich css library built on top of stylus. It's a child of the [roots build system](http://github.com/jenius/roots), but is totally old enough to live on it's own. It can be integrated as a plugin for stylus or included manually.
Axis is a terse, feature-rich css library built on top of stylus. It is built on top of [nib](http://visionmedia.github.io/nib/), providing a number of additional useful tools and mixins.

**Detailed documentation for axis [can be found here!](http://roots.cx/axis)**

## Usage
### Installation

Axis is already integrated into [roots](http://roots.cx) by default, and it's super easy to use it there. Definitely the easiest way if you are setting up a project that uses stylus anyway, and it comes with jade and coffeescript ready out of the box as well. However, if you do want to include manually in your own pipeline, here's how to make it happen with connect (or express):
You can install axis through npm, as such

```js
var connect = require('connect')
, stylus = require('stylus')
, axis = require('axis-css');

var server = connect();

function compile(str, path) {
return stylus(str)
.set('filename', path)
.use(axis());
}

server.use(stylus.middleware({
src: __dirname
, compile: compile
}));
```
npm install axis-css
```

### Usage

Axis is a [stylus](http://learnboost.github.io/stylus/) plugin, and can be integrated in any way that stylus plugins normally are. If you are curious how to use stylus plugins, feel free to check out [this guide](https://gist.github.com/jenius/8263065).

By default, axis' mixins will be included automatically into all parsed stylesheets when included as above. If you'd like to import axis manually in stylus when you want to use it, you can pass `{ implicit: false }` to the axis call, as such:

```js
function compile(str, path) {
return stylus(str)
.set('filename', path)
.use(axis({implicit: false}));
}
axis({ implicit: false })
```

If you do it this way, you'll need to `@import` axis manually wherever you'd like access to the mixins, as such:

```styl
@import 'axis'
normalize()
normalize-css()
base()
...etc...
```

## License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
### Miscellaneous

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- Details on the license [can be found here](license.md)
- Details on running tests and contributing [can be found here](contributing.md)

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/jenius/axis/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

0 comments on commit a2bdf3d

Please sign in to comment.