Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Yarn usage in README #148

Merged
merged 4 commits into from
May 29, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
save-exact = true
5 changes: 0 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ node_js:
- 8 # EOL: December 2019
- 6 # EOL: April 2019

script:
- npm run test-mocha
- npm run test-readme
- npm run lint

after_script:
- npm run coveralls

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2017 Jérémie Astori
Copyright (c) 2015 Jérémie Astori

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,18 @@ chai.use(require('./chai-immutable'));

### Node.js

Install via [npm](http://npmjs.org):
Install via [npm](http://npmjs.org) or [`yarn`](https://yarnpkg.com/en/):

```bash
npm install chai-immutable
npm install --save-dev chai-immutable
# or:
yarn add --dev chai-immutable
```

⚠️ To use `chai-immutable` with Chai v4, you need to use `npm install chai-immutable@next` instead, until I am done with the v2 release of this plugin. I apologize for the inconvenience in the meantime.
⚠️ To use `chai-immutable` with Chai v4, you need to use
`npm install --save-dev chai-immutable@next` (or
`yarn add --dev chai-immutable@next`) instead, until I am done with the v2
release of this plugin. I apologize for the inconvenience in the meantime.

You can then use this plugin as any other Chai plugins:

Expand Down
4 changes: 1 addition & 3 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,7 @@ install:
test_script:
- node --version
- npm --version
- npm run test-mocha
- npm run test-readme
- npm run lint
- npm run test

# Don't actually build
build: off
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
},
"scripts": {
"lint": "eslint --ignore-path .gitignore . --report-unused-disable-directives",
"test": "npm run test-mocha; npm run test-readme; npm run lint",
"test-readme": "mocha --compilers md:fulky/md-compiler README.md",
"test-mocha": "nyc mocha",
"test": "run-s --continue-on-error test:* lint",
"test:readme": "mocha --compilers md:fulky/md-compiler README.md",
"test:mocha": "nyc mocha",
"coveralls": "nyc report --reporter=text-lcov | coveralls"
},
"repository": {
Expand Down Expand Up @@ -51,6 +51,7 @@
"fulky": "0.2.0",
"immutable": "3.8.2",
"mocha": "5.2.0",
"npm-run-all": "4.1.3",
"nyc": "11.8.0"
}
}