Code Monkey home page Code Monkey logo

ghostreader's Introduction

๐Ÿ‘ป Ghost Reader - Find anything on the page.

Privacy

  • ๐Ÿ”’ We don't store your API key, it's only used to make requests to OpenAI API.
  • ๐Ÿšซ Nothing is sent to our servers because we don't have any ๐Ÿ˜€.

Welcome to our Chrome Extension

Our Chrome extension allows you to process the content on a webpage and use it to:

- Find the most important sentences on the page
- Answer user search queries using the content on the page
- Summarize the text on the page in a few sentences

Use your OpenAI API key

  • ๐Ÿ†“ Extension is free to use, but you need to provide your OpenAI API key. You can get it from OpenAI Dashboard.
  • ๐Ÿ”’ We don't store your API key, it's only used to make requests to OpenAI API.
  • ๐Ÿšซ Nothing is sent to our servers because we don't have any ๐Ÿ˜„.
How.to.generate.OpenAI.API.key.mp4

How to use

  • Install the extension from the Chrome Web Store
  • Generate a OpenAI key by visiting Open AI - API keys
  • Insert your OpenAI key into the extension (we don't store your key!)
  • Navigate to a webpage
  • Click the extension icon
  • Choose to either summarize the text or enter a search query on the page.

How search works

  • When you visit a webpage with the extension installed and enabled, the extension will create an embedding for the complete page. This embedding is cached until you close the page.
  • When you enter a search query, the extension creates an embedding for the search terms you are interested in.
  • The extension calculates the cosine similarity between the full page embedding and the search embedding.
  • If there is a relevant search term with 75% or more similarity, the extension will scroll the term into view and highlight it with a yellow background.

How summarization works

  • When you visit a webpage with the extension installed and enabled, the extension will store the complete page text.
  • When you click the summarize button, the extension will send the complete page text to the OpenAI API.
  • The OpenAI API will return a summary of the page text.
  • The extension will display the summary in a popup window.

We hope you find our extension helpful and welcome any feedback you may have. Thank you for using our extension!

How to build this code

npm install
npm run build

A new folder named dist should appear, use these instructions to load the (dist folder) extension to your browser.

ghostreader's People

Contributors

raghavan avatar bhavin-kamani avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

opxnai

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.