Skip to content

Commit bd877fa

Browse files
add LICENSE and README files for project documentation
1 parent f20903e commit bd877fa

File tree

2 files changed

+84
-0
lines changed

2 files changed

+84
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Gurvinder Dhillon
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Auto Browse Agent Chrome Extension
2+
3+
A Chrome extension that uses Puppeteer to automate browser interactions through a popup interface.
4+
5+
## Features
6+
7+
- Get the title of the current active tab
8+
- Highlight all links on the current page
9+
- Uses Puppeteer Core for browser automation
10+
- Simple popup UI with buttons and input field
11+
12+
## Setup
13+
14+
1. Clone the repository:
15+
16+
```bash
17+
git clone <repository-url>
18+
cd auto-browse-agent
19+
```
20+
21+
2. Install dependencies:
22+
23+
```bash
24+
npm install
25+
```
26+
27+
3. Build the extension:
28+
29+
```bash
30+
npm run build
31+
```
32+
33+
4. Load the extension in Chrome:
34+
35+
- Open Chrome and go to `chrome://extensions/`
36+
- Enable "Developer mode" in the top right
37+
- Click "Load unpacked" and select the `dist` directory
38+
39+
## Development
40+
41+
The extension consists of:
42+
43+
- `src/popup/popup.html` - The popup UI
44+
- `src/popup/popup.js` - Popup interaction logic
45+
- `src/background/background.js` - Background script with Puppeteer functionality
46+
- `public/manifest.json` - Extension manifest file
47+
48+
To make changes:
49+
50+
1. Modify the source files
51+
2. Run `npm run build` to rebuild
52+
3. Click the refresh icon in `chrome://extensions/` to reload the extension
53+
54+
## Usage
55+
56+
1. Click the extension icon to open the popup
57+
2. Enter a URL (optional)
58+
3. Click "Get Current Page Title" to fetch the active tab's title
59+
4. Click "Highlight All Links" to highlight all links on the current page
60+
61+
## License
62+
63+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)