Skip to content

Commit 08ee8f7

Browse files
committed
fix readme
1 parent 8174bd5 commit 08ee8f7

File tree

1 file changed

+25
-14
lines changed

1 file changed

+25
-14
lines changed

README.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
# JabRef Browser Extension
2+
23
> [Firefox](https://addons.mozilla.org/en-US/firefox/addon/jabref/?src=external-github) - [Chrome](https://chrome.google.com/webstore/detail/jabref-browser-extension/bifehkofibaamoeaopjglfkddgkijdlh) - [Edge](https://microsoftedge.microsoft.com/addons/detail/pgkajmkfgbehiomipedjhoddkejohfna) - [Vivaldi](https://chrome.google.com/webstore/detail/jabref-browser-extension/bifehkofibaamoeaopjglfkddgkijdlh)
34
45
Browser extension for users of the bibliographic reference manager [JabRef](https://www.jabref.org/).
56
It automatically identifies and extracts bibliographic information on websites and sends them to JabRef with one click.
67

78
When you find an interesting article through Google Scholar, the arXiv or journal websites, this browser extension allows you to add those references to JabRef.
8-
Even links to accompanying PDFs are sent to JabRef, where those documents can easily be downloaded, renamed and placed in the correct folder.
9+
Even links to accompanying PDFs are sent to JabRef, where those documents can easily be downloaded, renamed and placed in the correct folder.
910
[A wide range of publisher sites, library catalogs and databases are supported](https://www.zotero.org/support/translators).
1011

1112
_Please post any issues or suggestions [here on GitHub](https://github.com/JabRef/JabRef-Browser-Extension/issues)._
1213

1314
## Installation and Configuration
15+
1416
Normally, you simply install the extension from the browser store and are ready to go.
1517
> [Firefox](https://addons.mozilla.org/en-US/firefox/addon/jabref/?src=external-github) - [Chrome](https://chrome.google.com/webstore/detail/jabref-browser-extension/bifehkofibaamoeaopjglfkddgkijdlh) - [Edge](https://microsoftedge.microsoft.com/addons/detail/pgkajmkfgbehiomipedjhoddkejohfna) - [Vivaldi](https://chrome.google.com/webstore/detail/jabref-browser-extension/bifehkofibaamoeaopjglfkddgkijdlh)
1618
1719
Sometimes, a manual installation is necessary (e.g. if you use the portable version of JabRef). In this case, please follow the steps described [in the user manual](https://docs.jabref.org/import-export/import/jabref-browser-extension).
1820

1921
## Usage
22+
2023
After the installation, you should be able to import bibliographic references into JabRef directly from your browser.
2124
Just visit a publisher site or some other website containing bibliographic information (for example, [the arXiv](http://arxiv.org/list/gr-qc/pastweek?skip=0&show=5)) and click the JabRef symbol in the Firefox search bar (or press <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>J</kbd>).
2225
Once the JabRef browser extension has extracted the references and downloaded the associated PDF's, the import window of JabRef opens.
2326

2427
You might want to configure JabRef so that new entries are always imported in an already opened instance of JabRef.
2528
For this, activate "Remote operation" under the Network tab in the JabRef Preferences.
2629

27-
2830
## About this Add-On
2931

3032
Internally, this browser extension uses the magic of Zotero's site translators.
@@ -36,6 +38,7 @@ Note that this browser extension does not make any changes to the Zotero databas
3638
JabRef browser extension uses the [WebExtensions API](https://developer.mozilla.org/en-US/Add-ons/WebExtensions).
3739

3840
Preparation:
41+
3942
1. Install [Node.js](https://nodejs.org) (e.g., `choco install nodejs`)
4043
2. Install [gulp](https://gulpjs.com/) and [web-ext](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext): `npm install --global gulp-cli web-ext`
4144
3. [Fork the repository](https://help.github.com/articles/fork-a-repo/).
@@ -46,6 +49,7 @@ Preparation:
4649
Chrome: `npm run dev:opera`
4750

4851
Now just follow the typical steps to [contribute code](https://guides.github.com/activities/contributing-to-open-source/#contributing):
52+
4953
1. Create your feature branch: `git checkout -b my-new-feature`
5054
3. Build and run the add-on as described above.
5155
3. Commit your changes: `git commit -am 'Add some feature'`
@@ -54,28 +58,35 @@ Now just follow the typical steps to [contribute code](https://guides.github.com
5458

5559
To update dependencies:
5660

57-
- `npm outdated` gives an overview of outdated packages ([doc](https://docs.npmjs.com/cli/outdated))
58-
- `npm-upgrade` updates all packages
59-
- `npm install` install updated packages
60-
- running
61-
```
61+
- `npm outdated` gives an overview of outdated packages ([doc](https://docs.npmjs.com/cli/outdated))
62+
- `npm-upgrade` updates all packages
63+
- `npm install` install updated packages
64+
65+
If you execute it for the first time you have to use git subtree add and delete the module subdirs
66+
67+
- running
68+
69+
``` bash
6270
git subtree pull --prefix zotero-connectors https://github.com/zotero/zotero-connectors.git master --squash
63-
git subtree pull --prefix zotero-connectors/src/zotero https://github.com/zotero/zotero.git master --squash
71+
git subtree pull --prefix zotero-connectors/src/zotero https://github.com/zotero/zotero.git main --squash
6472
git subtree pull --prefix zotero-connectors/src/translate https://github.com/zotero/translate.git master --squash
6573
git subtree pull --prefix zotero-connectors/src/utilities https://github.com/zotero/utilities.git master --squash
74+
git subtree pull --prefix zotero-connectors/src/zotero-google-docs-integration https://github.com/zotero/zotero-google-docs-integration.git master
6675
git subtree pull --prefix zotero-scholar-citations https://github.com/MaxKuehn/zotero-scholar-citations.git master --squash
6776
```
77+
6878
updates the `zotero-connectors` submodule and the `zotero-scholar-citations` submodule
6979

70-
- `gulp update-external-scripts` copies and post-processes the scripts in the folders `zotero-connectors` and `zotero-scholar-citations` to the folder `external-scripts`
80+
- `gulp update-external-scripts` copies and post-processes the scripts in the folders `zotero-connectors` and `zotero-scholar-citations` to the folder `external-scripts`
7181

7282
## Release of new version
83+
7384
- Increase version number in `manifest.json`
7485
- `npm run build`
7586
- Upload to:
76-
- https://addons.mozilla.org/en-US/developers/addon/jabref/versions/submit/
77-
- https://chrome.google.com/u/2/webstore/devconsole/26c4c347-9aa1-48d8-8a22-1c79fd3a597e/bifehkofibaamoeaopjglfkddgkijdlh/edit/package
78-
- https://addons.opera.com/developer/upload/
79-
- https://developer.apple.com/app-store-connect/
87+
- <https://addons.mozilla.org/en-US/developers/addon/jabref/versions/submit/>
88+
- <https://chrome.google.com/u/2/webstore/devconsole/26c4c347-9aa1-48d8-8a22-1c79fd3a597e/bifehkofibaamoeaopjglfkddgkijdlh/edit/package>
89+
- <https://addons.opera.com/developer/upload/>
90+
- <https://developer.apple.com/app-store-connect/>
8091
- Remove the `key` field in `manifest.json` and build again. Then upload to:
81-
- https://partner.microsoft.com/en-us/dashboard/microsoftedge/2045cdc1-808f-43c4-8091-43e2dcaff53d/packages
92+
- <https://partner.microsoft.com/en-us/dashboard/microsoftedge/2045cdc1-808f-43c4-8091-43e2dcaff53d/packages>

0 commit comments

Comments
 (0)