Skip to content

Commit 4b2b917

Browse files
committed
Tighten README
1 parent 44b7866 commit 4b2b917

1 file changed

Lines changed: 11 additions & 35 deletions

File tree

README.md

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,10 @@
44

55
html2rss-web converts arbitrary websites into RSS 2.0 feeds with a slim Ruby backend and an Astro-powered frontend.
66

7-
## 🌐 Community & Resources
8-
9-
| Resource | Description | Link |
10-
| ------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------ |
11-
| **📚 Documentation & Feed Directory** | Complete guides, tutorials, and browse 100+ pre-built feeds | [html2rss.github.io](https://html2rss.github.io) |
12-
| **💬 Community Discussions** | Get help, share ideas, and connect with other users | [GitHub Discussions](https://github.com/orgs/html2rss/discussions) |
13-
| **📋 Project Board** | Track development progress and upcoming features | [View Project Board](https://github.com/orgs/html2rss/projects) |
14-
| **💖 Support Development** | Help fund ongoing development and maintenance | [Sponsor on GitHub](https://github.com/sponsors/gildesmarais) |
15-
16-
**Quick Start Options:**
17-
18-
- **New to RSS?** → Start with the [web application guide](https://html2rss.github.io/web-application)
19-
- **Need a specific feed?** → Browse the [feed directory](https://html2rss.github.io/feed-directory)
20-
- **Want to deploy?** → Check out [deployment guides](https://html2rss.github.io/web-application/how-to/deployment)
21-
- **Want to contribute?** → See our [contributing guide](https://html2rss.github.io/get-involved/contributing)
7+
## Links
8+
- Docs & feed directory: https://html2rss.github.io
9+
- Discussions: https://github.com/orgs/html2rss/discussions
10+
- Sponsor: https://github.com/sponsors/gildesmarais
2211

2312
## Highlights
2413
- Responsive Astro interface with gallery and custom feed creation.
@@ -32,7 +21,7 @@ html2rss-web converts arbitrary websites into RSS 2.0 feeds with a slim Ruby bac
3221
- **Distribution:** Docker Compose by default; other deployments require manual wiring.
3322

3423
## Documentation
35-
The in-repo docs live under `frontend/src/content/docs/` and are published by Astro.
24+
In-repo docs live under `frontend/src/content/docs/` and are published by Astro.
3625
- [Configuration Guide](frontend/src/content/docs/configuration.md)
3726
- [Security Guide](frontend/src/content/docs/security.md)
3827
- [REST API v1](frontend/src/content/docs/api/v1.md)
@@ -51,20 +40,12 @@ curl -X POST "https://your-domain.com/api/v1/feeds" \
5140
-d '{"url":"https://example.com","name":"Example Feed"}'
5241
```
5342

54-
## Deploy with Docker Compose
55-
The supported path is Docker Compose.
56-
57-
### Prerequisites
58-
- Docker Engine and Docker Compose
59-
- Git for cloning the repository
43+
## Deploy (Docker Compose)
44+
1. Generate a key: `openssl rand -hex 32`.
45+
2. Set `HTML2RSS_SECRET_KEY` in `docker-compose.yml`.
46+
3. Start: `docker-compose up`.
6047

61-
### Steps
62-
1. Clone the repository and change into the directory.
63-
2. Generate a 64-character hexadecimal key: `openssl rand -hex 32`.
64-
3. Update `docker-compose.yml` with the key via the `HTML2RSS_SECRET_KEY` environment variable.
65-
4. Start the stack: `docker-compose up`.
66-
67-
The application serves the UI and API at `http://localhost:3000`. It fails fast if the secret key is missing.
48+
UI + API run on `http://localhost:3000`. The app exits if the secret key is missing.
6849

6950
## Frontend Development
7051
```
@@ -109,9 +90,4 @@ The Ruby server continues to serve the production build while Astro runs with ho
10990
| Docker smoke | RSpec (`:docker`) | Net::HTTP probes against the containerised service. |
11091

11192
## Contributing
112-
113-
Contributions are welcome. See the [html2rss project guidelines](https://html2rss.github.io/get-involved/contributing) before opening a pull request.
114-
115-
## Sponsoring
116-
117-
Support ongoing development via [GitHub Sponsors](https://github.com/sponsors/gildesmarais).
93+
See the [html2rss project guidelines](https://html2rss.github.io/get-involved/contributing).

0 commit comments

Comments
 (0)