Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vpj authored Jan 15, 2022
1 parent ad8028e commit 2084a0b
Showing 1 changed file with 32 additions and 11 deletions.
43 changes: 32 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,35 @@
# chrome-extension
# [papers.labml.ai](https://papers.labml.ai) Chrome extension

Source code of the papers.labml.ai Chrome extension
This is the source code of the papers.labml.ai Chrome extension.

## Setting up
## [Get it from Chrome webstore]()

1. Create a directory named lib
2. Add [weya](https://github.com/vpj/weya) to that directory either by directly cloning or adding a symlink (Make sure
you have the latest version of weya if symlinking)
3. Run `npm install`
4. Run `npm run build`
5. Turn on developer mode on chrome
6. Click load unpacked extension on chrome
7. Select the `build` folder that was created after 4th step
## About

🔎 View information about research papers linked from websites you visit.

This extension shows you the following details about research papers:
✨ 2-line summary
✨ Availability source code, videos, and discussions
✨ Popularity on Twitter
✨ Conferences

When you visit a website or a web app the extension icon (flask icon) in the browser will show a small badge that indicates the number of research papers found on that website. Click the extension icon to see the list of papers with summaries and other information. You can click on a paper to see the full details.

Optionally, the extension can also add an icon (📎) next to the links to research papers. You can click this icon to get the paper summary and other information.

This works on any website; for example, Google search, Twitter, blogs, tutorials, forums.

### How it works

This extension will extract the links to research papers from the websites you visit and send them to labml.ai servers to retrieve papers summaries. We need permission to "Allow this extension to read and change all your data on websites you visit: on all sites" to do this.

We have made the source code of this extension public for better transparency (and if anyone in the community wants to help us improve it 😊).

Github: [https://github.com/labmlai/chrome-extension](https://github.com/labmlai/chrome-extension)

## Building the extension locally

1. Add [weya](https://github.com/vpj/weya) to `./lib`
2. Run `npm install`
3. Run `npm run build`

0 comments on commit 2084a0b

Please sign in to comment.