From a7ee0902fedce341cd26051271b015aee1ecea1c Mon Sep 17 00:00:00 2001 From: Naoufal Kadhom Date: Mon, 15 Feb 2016 16:43:00 -0500 Subject: [PATCH] Update readme --- packages/eslint-config-unsplash/README.md | 30 ++++++++++++++++++++ packages/eslint-config-unsplash/package.json | 2 +- 2 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 packages/eslint-config-unsplash/README.md diff --git a/packages/eslint-config-unsplash/README.md b/packages/eslint-config-unsplash/README.md new file mode 100644 index 0000000..89b2d26 --- /dev/null +++ b/packages/eslint-config-unsplash/README.md @@ -0,0 +1,30 @@ +# eslint-config-unsplash + +[![npm](https://img.shields.io/npm/v/eslint-config-unsplash.svg?style=flat-square)](https://www.npmjs.com/package/eslint-config-unsplash) +[![npm](https://img.shields.io/npm/dm/eslint-config-unsplash.svg?style=flat-square)](https://www.npmjs.com/package/eslint-config-unsplash) +[![Codeship](https://img.shields.io/codeship/be68ebe0-b655-0133-e189-7a4b33b8d70b/master.svg?style=flat-square)](https://codeship.com/projects/be68ebe0-b655-0133-e189-7a4b33b8d70b/status?branch=master) + +This package holds Unsplash's ESLint config. + +## Installation +``` +npm i --save-dev eslint eslint-config-unsplash +``` + +## Usage +To get started, extend Unsplash's configuration in you `.eslintrc`. + +```json +{ + "extends": "unsplash" +} +``` + +Now that you're setup, running the following will lint your code. + +```bash +./node_modules/.bin/eslint . +``` + +## The Rules +See [Unsplash's JavaScript Style Guide](https://github.com/unsplash/javascript). diff --git a/packages/eslint-config-unsplash/package.json b/packages/eslint-config-unsplash/package.json index 35d7485..cedba58 100644 --- a/packages/eslint-config-unsplash/package.json +++ b/packages/eslint-config-unsplash/package.json @@ -1,6 +1,6 @@ { "name": "eslint-config-unsplash", - "version": "0.1.0", + "version": "0.1.2", "description": "Unsplash's ESLint Config", "main": "index.js", "scripts": {