Skip to content

Commit af1437d

Browse files
docs: update README.md
1 parent c8a5481 commit af1437d

4 files changed

Lines changed: 39 additions & 4 deletions

File tree

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,45 @@
11
# GitHub Emoji
22

3-
A chrome extension of github emoji picker for fun :slightly_smiling_face: :octocat: :upside_down_face:.
3+
A chrome extension for the github emoji picker with fun :sunglasses:.
44

55
## Preview
66

7-
![github-emoji](https://github.com/FishPlusOrange/github-emoji/blob/master/docs/screenshot.png)
7+
![github-emoji](https://raw.githubusercontent.com/FishPlusOrange/github-emoji/master/docs/screenshot.png)
8+
9+
## Install
10+
11+
:point_right: Chrome Extension
12+
13+
- [Let's get it]() :call_me_hand:
14+
15+
:point_right: Manual Installation
16+
17+
- Get "GitHub Emoji"
18+
19+
Clone with Git, or install with npm, or `yarn add` if you are using yarn as the package manager:
20+
21+
```bash
22+
# git
23+
git clone https://github.com/FishPlusOrange/github-emoji.git
24+
```
25+
26+
```bash
27+
# npm
28+
npm install @fishplusorange/github-emoji
29+
```
30+
31+
```bash
32+
# yarn
33+
yarn add @fishplusorange/github-emoji
34+
```
35+
36+
- Open "Chrome Extension" page
37+
38+
- Check "Developer Mode"
39+
40+
- Click "Load Unpacked Extension", and choose the folder `chrome`
41+
42+
- Have fun :call_me_hand:
843

944
## License
1045

chrome/manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "GitHub Emoji",
33
"version": "1.1.0",
44
"manifest_version": 2,
5-
"description": "A chrome extension of github emoji picker for fun.",
5+
"description": "A chrome extension for the github emoji picker with fun.",
66
"homepage_url": "https://github.com/FishPlusOrange/github-emoji",
77
"icons": {
88
"16": "images/octocat.png",

docs/screenshot.png

47.1 KB
Loading

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"version": "1.1.0",
44
"author": "FishPlusOrange",
55
"license": "MIT",
6-
"description": "A chrome extension of github emoji picker for fun",
6+
"description": "A chrome extension for the github emoji picker with fun",
77
"scripts": {
88
"dev": "webpack --mode-development --watch",
99
"build": "webpack --mode-production",

0 commit comments

Comments
 (0)