From 2084a0b1519dc850f5143d16ae6661c2ff880216 Mon Sep 17 00:00:00 2001 From: Varuna Jayasiri Date: Sat, 15 Jan 2022 15:59:13 +0530 Subject: [PATCH] Update README.md --- README.md | 43 ++++++++++++++++++++++++++++++++----------- 1 file changed, 32 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a55bf77..ac1d83a 100644 --- a/README.md +++ b/README.md @@ -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`