Skip to content

Commit 687d6d9

Browse files
committed
Update readme
1 parent fcc1f98 commit 687d6d9

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ This is a **Chrome and Firefox Extension** that allows you to open threads in Gi
44

55
## Features
66

7-
### Mail View Shortcut
7+
#### Mail View Shortcut
88

99
Open your GitHub notifications using a shortcut (default to `shift + g`, or `shift + b` to open in the background in Chrome), or this button in mail view:
1010

1111
![image](https://f.cloud.github.com/assets/1153134/1699454/20634378-5f9f-11e3-999c-c0c5e3e96684.png)
1212

13-
### List View Shortcut
13+
#### List View Shortcut
1414

1515
The shortcut is `ctrl + return(enter)`, currently non-customisable. It will trigger one of these two when an email is selected using key navigation(when the blue bar appears):
1616

@@ -19,61 +19,60 @@ The shortcut is `ctrl + return(enter)`, currently non-customisable. It will trig
1919

2020
The function will only look for a label if there is no action buttons.
2121

22-
#### Action button
22+
##### Action button
2323

2424
![action button in list view](https://cloud.githubusercontent.com/assets/1153134/4344159/52248e7c-407b-11e4-9c80-fdc9f8a9f8cc.png)
2525

26-
#### Label
26+
##### Label
2727

2828
![label in list view](https://f.cloud.github.com/assets/1153134/2073597/f19b6232-8d61-11e3-8e65-b03db4e72217.png)
2929

3030
## Installation
3131

32-
### The Easy Way
32+
#### The Easy Way
3333

34-
[Install the extension via Chrome webstore](https://chrome.google.com/webstore/detail/github-notification-helpe/gmhijkhbpihfmkmhmcfebmlkaekgmaje)
34+
[Install the extension via Chrome webstore](https://chrome.google.com/webstore/detail/github-notification-helpe/gmhijkhbpihfmkmhmcfebmlkaekgmaje) or [Install the addon via Firefox addons gallery](https://addons.mozilla.org/en-US/firefox/addon/github-for-gmail/)
3535

36-
### The Mu-An-might-steal-all-my-data-so-I-want-to-manually-load-it Way
36+
#### The Mu-An-might-steal-all-my-data-so-I-want-to-manually-load-it Way (for Chrome)
3737

3838
1. Go to [Releases](https://github.com/muan/github-gmail/releases) and download the latest version.
3939
2. Unzip the folder wherever you'd like.
40-
3. Go to Chrome extensions page (`chrome://extensions/`) and load the folder as an **Unpacked extension**.
40+
3. Read Mu-An's code making sure there is no data stealing.
41+
4. Go to Chrome extensions page (`chrome://extensions/`) and load the folder as an **Unpacked extension**.
4142

4243
As:
4344

4445
![image](https://f.cloud.github.com/assets/1153134/1749652/ae692df6-652e-11e3-869f-65447bfe1a68.png)
4546

4647
## Options and preferences
4748

48-
![](https://f.cloud.github.com/assets/1153134/1715451/2fcb1c8a-61b3-11e3-9960-1f3ef6a48f48.png)
49-
5049
There are 3 preference settings:
5150

5251
1. Custom domains
5352
2. Mail view shortcut
5453
3. List view regular expression
5554

56-
**Attention** After updating a setting, please refresh both the extensions page in Chrome and the Gmail page.
55+
**Attention** After updating a setting, please refresh both the extensions page and the Gmail page.
5756

58-
### Custom Domains (for GitHub Enterprise)
57+
#### Custom Domains (for GitHub Enterprise)
5958

6059
If you are using GitHub enterprise and have a custom domain, you can set it in the extension options page.
6160

6261
![domain option](https://f.cloud.github.com/assets/1153134/2075910/2f9b1f70-8d97-11e3-9798-9afcfb550e22.png)
6362

64-
### Mail View Shortcut
63+
#### Mail View Shortcut
6564

6665
Customize the keyboard shortcut that triggers the `View on GitHub` button. Change the shortcut combination by focusing the input, and press whatever key(s) you want to be the shortcut. It will be displayed in `keyCode` which is why you see `71` here instead of `g`. Don't worry about it.
6766

68-
#### To open and focus the new window right away (`shift + g`):
67+
##### To open and focus the new window right away (`shift + g`):
6968

7069
![image](https://f.cloud.github.com/assets/1153134/2457119/3a485f38-af2e-11e3-978a-ece296676337.png)
7170

72-
#### To open a new window in the background (`shift + b`) – Chrome only:
71+
##### To open a new window in the background (`shift + b`) – Chrome only:
7372

7473
![image](https://f.cloud.github.com/assets/1153134/2466997/e381dbc2-afb7-11e3-9470-bc722133a265.png)
7574

76-
### List View Regular Expression
75+
#### List View Regular Expression
7776

7877
Custom Regular Expression for matching labeled Organization name. Eg. `/^\((.+)\)/` matches `muan` in `(muan)\github-gmail`, and will be use to build the url: `https://github.com/`**`muan`**`/github-gmail/issues`.
7978

@@ -83,7 +82,8 @@ This is **not needed** if all you need is triggering the action button.
8382

8483
## Code
8584

86-
All the core functions are written in `src/inject/inject.js`.
85+
Chrome: `chrome/src/inject/inject.js`.<br>
86+
Firefox: `firefox/data/index.js`.
8787

8888
## The End
8989

0 commit comments

Comments
 (0)