Skip to content

Commit 64eaf18

Browse files
chore: readme
1 parent 2ec1710 commit 64eaf18

File tree

1 file changed

+38
-29
lines changed

1 file changed

+38
-29
lines changed

README.md

Lines changed: 38 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,62 @@
1-
# Gemini Recommended Search
1+
![logo](readme_images/banner.png)
2+
3+
# Summary
24
A Google AI hackathon project by Michael Gathara and Jayden Pyles. Built on top of the [Chrome Extension Typescript Starter](https://github.com/chibat/chrome-extension-typescript-starter)
35

4-
## Prerequisites
6+
As you browse the web, Gemini Recommended Search scans your content and leverages Gemini's advanced capabilities to generate precise Google search queries. Instantly, you're presented with additional webpages tailored to you—allowing you to find content across the web that helps you.
7+
8+
## Features
9+
10+
### Smart Content Discovery and Content Summary
11+
- Seamlessly discover relevant content as you browse
12+
- Get intelligent recommendations based on your current page context
13+
- Save time finding related resources across the web
14+
- Get content summaries to enhance understanding
515

6-
* [node + npm](https://nodejs.org/) (Current Version)
16+
![main_use](readme_images/main_use.png)
717

8-
## Includes the following
18+
### Powered by Gemini AI
19+
- Advanced content analysis for precise recommendations
20+
- Real-time query generation tailored to your interests
21+
- High-quality results powered by Google's latest AI technology
922

10-
* TypeScript
11-
* Webpack
12-
* React
13-
* Jest
14-
* Example Code
15-
* Chrome Storage
16-
* Options Version 2
17-
* content script
18-
* count up badge number
19-
* background
23+
### Simple & Privacy-Focused
24+
- Works automatically in the background while you browse
25+
- Your browsing data stays local to your device
2026

21-
## Project Structure
27+
## How to run
28+
### Prerequisites
2229

23-
* src/typescript: TypeScript source files
24-
* src/assets: static files
25-
* dist: Chrome Extension directory
26-
* dist/js: Generated JavaScript files
30+
* [node + npm](https://nodejs.org/)
31+
* [Docker](https://www.docker.com/)
32+
* [Python](https://python.org/)
33+
* [Make](https://www.gnu.org/software/make/)
2734

28-
## Setup
2935

36+
### Setup
37+
38+
- Frontend
3039
```
3140
npm install
3241
```
3342

34-
## Build
43+
- Backend
44+
```
45+
make build up
46+
```
47+
48+
### Build frontend assets
3549

3650
```
3751
npm run build
3852
```
3953

40-
## Build in watch mode
41-
42-
### terminal
54+
or
4355

4456
```
45-
npm run watch
57+
make build-ext
4658
```
4759

48-
## Load extension to chrome
60+
### Load extension to chrome
4961

5062
Load `dist` directory
51-
52-
## Test
53-
`npx jest` or `npm run test`

0 commit comments

Comments
 (0)