Skip to content

Commit aac5553

Browse files
committed
chore: update docs
1 parent 0479c2e commit aac5553

File tree

2 files changed

+6
-24
lines changed

2 files changed

+6
-24
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,17 @@
1-
Contributing
2-
===
1+
# Contributing
32

4-
This project follows [Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/), and as such has ``master`` and ``develop`` branches.
5-
6-
## Prerequisites
7-
8-
1. Install the appropriate [EditorConfig](http://editorconfig.org) plugin for your IDE/editor. This helps keep the code style consistent.
9-
2. Install [PhantomJS](http://phantomjs.org). Make sure it's on your path / available when calling `phantomjs` from the command line.
10-
2. `npm install -g gulp`
11-
3. `npm install`
3+
This project follows [Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/), and as such has `master` and `develop` branches.
124

135
## Running the tests
146

15-
- All tests: `npm test`
16-
- Just the browser ones: `phantomjs tests/phantom.js`
17-
- Just the Node ones: `node tests/node.js`
7+
- Tests: `npm run test`
8+
- In browser: `npm run test:browser`
189

1910
## Before creating a pull request
2011

2112
Make sure you do the following:
2213

23-
- Run `gulp`
14+
- Run `npm run build`
2415

2516
Note: The build script will generate new `*.min.{css,js}` files. If, for example, you only changed the JavaScript then don't bother committing `emojify.min.css`.
2617

@@ -31,10 +22,3 @@ Before a release, generate a commit log:
3122
```
3223
git log --pretty=format:"- %s" >> log.md
3324
```
34-
35-
If you have rights to publish to npm, do the following first:
36-
37-
- Run `gulp update`. This will update the project with the latest emoji from [emoji-cheat-sheet.com](http://www.emoji-cheat-sheet.com).
38-
- Run `gulp`
39-
- Run `gulp bump`
40-
- Run `npm publish`

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ Note: This fork is a rewrite version from joypixels/emojify.js with TypeScript a
44

55
Below is the original README
66

7-
TODO: update it
8-
97
---
108

119
A swiss-army-knife for all emoji, in Javascript. Used by [Gitter](https://gitter.im/) and [Mapbox](https://www.mapbox.com/blog/emoji-map-markers/).
@@ -28,7 +26,7 @@ The emoji keywords are as described by [emoji-cheat-sheet.com](http://www.emoji-
2826

2927
### Via npm
3028

31-
`npm install @hackmd/emojify.js --save`
29+
`npm install @hackmd/emojify.js --save`
3230

3331
## API
3432

0 commit comments

Comments
 (0)