Skip to content

Commit a1c3279

Browse files
author
Andrew E. Rhyne
committed
doc update and yarn integration
1 parent 97f2ca2 commit a1c3279

File tree

7 files changed

+2344
-4
lines changed

7 files changed

+2344
-4
lines changed

.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# editorconfig.org
22
root = true
33

4-
[*]
4+
[*.js]
55
indent_style = space
66
indent_size = 2
77
end_of_line = lf

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
logs
33
*.log
44
npm-debug.log*
5+
yarn-debug.log*
56

67
# Runtime data
78
pids

.npmignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ src
22
test
33
coverage
44
npm-debug.log
5+
yarn-debug.log
6+
yarn.lock
57
.DS_Store
68
.gitignore
79
circle.yml

Makefile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
PATH := node_modules/.bin:$(PATH)
22
SHELL := /bin/bash
3-
3+
NODE ?= $(shell which node)
4+
YARN ?= $(shell which yarn)
5+
PKG ?= $(if $(YARN),$(YARN),$(NODE) $(shell which npm))
46
.FORCE:
57

8+
install: .FORCE
9+
$(PKG) install
10+
611
all: .FORCE
712
babel src -d lib
813

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Redis is great for a lot of things, and we love using it at Jobstart. Caching,
2222

2323
## Notes
2424

25-
Microlock is currently compatible with Etd 2.2.x. Within the next two weeks, there will be full support and test coverage for Etcd 2.2.x - 3.x.
25+
Microlock is currently compatible with Etd 2.2.x. Work on support for Etcd 2.2.x - 3.x is in progress.
2626

2727
## Install
2828
**Requires NodeJS >= 4.0**
@@ -208,7 +208,11 @@ foo.on('locked', function () {
208208

209209
## Contributing
210210

211-
Submit a PR. Easy at that!
211+
### Installing packages
212+
213+
```bash
214+
$ make install
215+
```
212216

213217
### Building
214218

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
"eslint-plugin-babel": "^3.2.0",
3636
"mocha": "^2.4.5",
3737
"node-etcd": "^5.0.3",
38+
"rimraf": "^2.5.4",
3839
"sinon": "^1.17.3",
3940
"source-map-support": "^0.4.2"
4041
}

0 commit comments

Comments
 (0)