Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
piraces committed Nov 5, 2021
1 parent a13d7c3 commit 2cabe44
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,20 @@
![Dark theme gif](assets/gifs/extension-light.gif)
![Light theme tooltip screenshot](assets/screenshots/light-tooltip.png)

## Download
# Download

**Get the extension:**
- For Edge: [https://microsoftedge.microsoft.com/addons/detail/tldr-pages/hbplonhehblpcghgkhnjepdbohbpkoak](https://microsoftedge.microsoft.com/addons/detail/tldr-pages/hbplonhehblpcghgkhnjepdbohbpkoak)
- For Edge: [Microsoft Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/tldr-pages/hbplonhehblpcghgkhnjepdbohbpkoak)
- For Chrome: [in the Chrome Store](https://chrome.google.com/webstore/detail/tldr-pages/fcccijijdgmmcjnifgdhcmepnkcdingf).
- For Firefox: [Firefox Browser Add-ons](https://addons.mozilla.org/es/firefox/addon/tldr-pages/).

# How it works

- Highlight and right click a command on your webpage and select `tldr-pages` in the drop down - a tooltip should appear with information fetched from [tldr-pages](https://github.com/tldr-pages/tldr).


# Development

## Loading Extension for development

- The extension is yet to be released to the chrome webstore.
Expand All @@ -33,12 +40,7 @@ npm run process-styles
```
- To load the extension, download the repository and open the extension preferences in Chrome/Chromium based browsers (go to `chrome://extensions`). Click the box marked as `Developer mode` and click the button `Load unpacked extension...` after which you can navigate to the project directory and load tldr-pages.


## How it works

- Highlight and right click a command on your webpage and select `tldr-pages` in the drop down - a tooltip should appear with information fetched from [tldr-pages](https://github.com/tldr-pages/tldr).

# Contribute
## Contribute

👷‍♂️ There is **[work in progress](https://github.com/piraces/tldr-extension-browser/projects/1) for this extension**

Expand Down

0 comments on commit 2cabe44

Please sign in to comment.