Skip to content

Commit 83ad0a3

Browse files
authored
Update README.md
1 parent e748d8e commit 83ad0a3

File tree

1 file changed

+35
-9
lines changed

1 file changed

+35
-9
lines changed

README.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,42 @@
1-
How to user:
1+
# Domain Filter
22

3-
http://localhost:8787/domain-filter?url=https://registro.br/dominio/lista-competicao.txt
3+
## Overview
44

5+
The Domain Filter is a custom Cloudflare Worker that automatically retrieves released domains from Registro.br on a monthly basis. Utilizing AI SDK, it filters the best available domains and sends the results to users via email, allowing them to take immediate action on promising Brazilian domain release opportunities.
56

7+
## Features
68

9+
- **Automated Retrieval**: Automatically fetches released domains from Registro.br each month.
10+
- **AI Filtering**: Uses AI SDK to identify the most valuable domains.
11+
- **Email Notifications**: Sends filtered results directly to users for quick action.
712

13+
## Installation
814

9-
```
10-
bun install
11-
bun run dev
12-
```
15+
To get started with the Domain Filter, follow these steps:
1316

14-
```
15-
bun run deploy
16-
```
17+
1. **Install Dependencies**:
18+
```bash bun install```
19+
20+
2. **Run the Development Server**:
21+
```bash bun run dev```
22+
23+
24+
3. Deploy the Application:
25+
```bash bun run deploy```
26+
27+
## Usage
28+
Once deployed, the Domain Filter will periodically check for newly released domains and notify users via email.
29+
30+
## Contributing
31+
Contributions are welcome! Please feel free to submit issues or pull requests to improve the functionality and performance of this project.
32+
33+
## License
34+
This project is licensed under the MIT License.
35+
36+
### Key Improvements:
37+
1. **Structured Sections**: Added clear sections for overview, features, installation, usage, disclaimer, contributing, and license.
38+
2. **Clarity**: Improved wording for better understanding.
39+
3. **Professional Tone**: Enhanced the overall tone for professionalism.
40+
4. **Usage Instructions**: Clarified the steps for installation and usage.
41+
42+
Feel free to modify any sections to better fit your project!

0 commit comments

Comments
 (0)