Merge pull request #3 from chadfawcett/exported-config

v2.0.0 - Change config to be an exported JS object

README.md

@@ -2,14 +2,24 @@
 
 ## Usage
 
-Installing the package will make a symlink in the root of your project to the
-prettier config in this repo. It is recommended to add `.prettierrc` to your
-`.gitignore` so you don't accidentally commit the symlink.
-
 ```bash
 npm install --save-dev @twostoryrobot/prettier
 ```
 
+Then you can source the config from your own `prettier.config.js`.
+
+```js
+module.exports = require('@twostoryrobot/prettier')
+```
+
+Or if you want to override the default at all (Note: please consider making a PR
+if you think the override will be useful for other projects).
+
+```js
+const prettierConfig = require('@twostoryrobot/prettier')
+module.exports = Object.assign({}, prettierConfig, { semi: true })
+```
+
 Make sure to install the peer dependencies
 
 ```bash

package.json

@@ -1,11 +1,8 @@
 {
   "name": "@twostoryrobot/prettier",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "prettier configuration for Two Story Robot",
-  "main": "index.js",
-  "scripts": {
-    "postinstall": "ln -fs $(pwd)/prettierrc $(pwd)/../../../.prettierrc"
-  },
+  "main": "prettier.config.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/TwoStoryRobot/prettier-config.git"

prettier.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  semi: false,
+  singleQuote: true,
+  jsxBracketSameLine: true
+}