Merge pull request #15 from siimple/2.0.0

2.0.0

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [siimple@juanes.xyz](mailto:siimple@juanes.xyz). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing to siimple
+
+First, thanks a lot for taking the time to contribute to the **siimple** project! :blush::tada:
+
+Here you have the guidelines that you must read before start contributing to **siimple**.
+
+### Code of Conduct
+
+You must read and follow the [code of conduct](./CODE_OF_CONDUCT.md) of **siimple**.
+
+### Questions or problems
+
+We are happy to help you if you have any problem or question using **siimple**. Please, send your problem to the [Google Group](https://groups.google.com/d/forum/siimple) discussion list.
+
+### Issues or bugs
+
+If you want to report a bug or issue, please open a new [issue here](https://github.com/siimple/siimple/issues) and include as many details as possible with your report. Adding code or screenshots are very helpful.
+
+Also, you can help us and publish a new [pull request](https://github.com/siimple/siimple/pulls) with the fix of the bug or issue.
+
+### New features
+
+You can request a new feature by [submitting a new issue](https://github.com/siimple/siimple/issues), or implement your new feature and [submit a new pull request](https://github.com/siimple/siimple/pulls) to the main repository. Keep in mind that the new feature must follow the style of **siimple**.

README.md

@@ -1,50 +1,131 @@
-[![Siimple](http://siimple.juanes.xyz/img/siimple.png)](http://siimple.juanes.xyz/)
-
-# Siimple
+# siimple
 
 [![npm](https://img.shields.io/npm/v/siimple.svg?style=flat-square)](https://www.npmjs.com/package/siimple)
 [![npm](https://img.shields.io/npm/dt/siimple.svg?style=flat-square)](https://www.npmjs.com/package/siimple)
 [![devDependency Status](https://david-dm.org/siimple/siimple/dev-status.svg?style=flat-square)](https://david-dm.org/siimple/siimple#info=devDependencies)
+[![npm](https://img.shields.io/npm/l/siimple.svg?style=flat-square)](https://github.com/siimpl/siimple)
 
 
 ## About
 
-**Siimple** is a minimal and light CSS framework for flat and clean designs created by [Josemi Juanes](http://jm.juanes.xyz), and built using SASS/SCSS. The result is a clean starting point for your front-end developments with a 5Kb minimized version.
-
-NOTE: **Siimple** wasn't created for competing with Bootstrap.
+**siimple** is a minimal and light CSS framework for flat and clean designs built using SASS/SCSS. The result is a clean starting point for your front-end developments with a 5Kb minimized version.
 
 ## Getting started
 
-There are three ways to download **Siimple**:
+First, install **siimple** in your project using one of the following methods:
 
-- Using [npm](http://npmjs.org/package/siimple): `npm install siimple`.
-- Using [bower](http://bower.io): `bower install siimple`.
-- Download the latest release: [https://github.com/siimple/siimple/releases](https://github.com/siimple/siimple/releases).
-- Clone the repo: `git clone https://github.com/siimple/siimple.git`.
+### Using npm
 
-For more information about **Siimple**, please visit the [Siimple homepage](http://siimple.juanes.xyz) and read the [getting started](http://siimple.juanes.xyz/getting-started) guide or the [reference](http://siimple.juanes.xyz/reference).
+Install the latest version from [npm](http://npmjs.org/package/siimple):
+
+```
+npm install --save siimple
+```
 
-## Build
+### Using bower
 
-By default, you have a compiled version of **Siimple** in the `dist/` folder. Nevertheless, you can build your local copy of **Siimple** in two steps. First, install the dev-dependencies using **npm**:
+Install the latest version from [bower](http://bower.io):
 
-```sh
-npm install
+```
+bower install siimple
+```
+
+### Clone the git repository
+
+You can also clone the git repository hosted on [GitHub](https://github.com/siimple/siimple):
+
+```
+git clone https://github.com/siimple/siimple.git
 ```
 
-Then, build the **Siimple** source code (placed in `src/`) using **Gulp**:
+## Usage
 
-```sh
-gulp default
+The main `css` file is located in the `dist/` folder. Include it on every `HTML` file of your project by adding the following tag:
+
+```
+<link rel="stylesheet" type="text/css" href="./path/to/siimple/dist/siimple.css">
 ```
 
-This will generate a compiled version in `dist/` folder.
+Or you can use the hosted version on [jsDelivr](https://www.jsdelivr.com/projects/siimple):
+
+```
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/siimple/VERSION/siimple.min.css">
+```
+
+Guides and reference are published in [siimple.juanes.xyz/docs](http://siimple.juanes.xyz/docs). Take a look and start creating your web page!
+
+## Using the SCSS/SASS mixins
+
+You can use the SASS/SCSS mixins located in the `scss/` folder. You need also the **siimple-colors**.
+
+#### Install using npm
+
+This is the easy way. Simply run the following command:
+
+```
+npm install siimple
+```
+
+This will download **siimple** and **siimple-colors** in the `node_modules` folder. You can then include all the mixins adding the following line to your `.scss` file:
+
+```
+@import "./node_modules/siimple/scss/_mixins.scss";
+```
+
+#### Install using bower
+
+Run the following command:
+
+```
+bower install siimple siimple-colors
+```
+
+And then include all the mixins adding the following line to your `.scss` file:
+
+```
+@import "./bower_components/siimple/scss/_mixins.scss";
+```
+
+## Build siimple
+
+First, install [gulp](http://gulpjs.com) globally:
+
+```
+npm install -g gulp
+```
+
+Then, clone this repository:
+
+```
+git clone https://github.com/siimple/siimple.git
+```
+
+and also clone the **siimple-colors** repository at the same parent folder:
+
+```
+git clone https://github.com/siimple/siimple-colors.git
+```
+
+Now, `cd` to the **siimple** repository and install all the dependencies using `npm`:
+
+```
+cd ./siimple
+npm install
+```
+
+Use `gulp` to compile the SCSS files and generate the `.css` files in the `dist/` folder running the following commands
+
+```
+gulp build:scss
+gulp minimize
+```
 
 
 ## Contribute
 
-You can contribute with **Siimple** installing it and submitting issues and pull requests :)
+We appreciate all contributions to the **siimple** project and help make it better! Please, read the [contributing guidelines](./CONTRIBUTING.md) before starting your contribution.
+
 
 ## License
 
-**Siimple** is under the [MIT](LICENSE) license.
+**siimple** is under the [MIT](LICENSE) license. &copy; Josemi Juanes.