Skip to content

Commit 37d0915

Browse files
committed
docs: Add comprehensive README documentation
- Added `README.md` file with detailed documentation - Documented background, installation, usage, example, contributing, and license - Included prerequisites for installation (Rust 1.56+ and Docker) - Provided instructions for cloning the repository and building the project - Added instructions for Docker deployment - Described how to access the rendering service once it is running
1 parent 38d780e commit 37d0915

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

README.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# renderer_rs
2+
3+
`renderer_rs` is a project written in Rust, aiming to port the [zenato/puppeteer-renderer](https://github.com/zenato/puppeteer-renderer) project. The currently implemented example is:
4+
5+
- Rendering web content via `http://localhost:8080/html?url=http://www.google.com`.
6+
7+
## Table of Contents
8+
9+
- [Background](#background)
10+
- [Installation](#installation)
11+
- [Usage](#usage)
12+
- [Example](#example)
13+
- [Contributing](#contributing)
14+
- [License](#license)
15+
16+
## Background
17+
18+
The `renderer_rs` project aims to provide a web rendering service using Rust and Headless Chrome. This project ports the functionality of [zenato/puppeteer-renderer](https://github.com/zenato/puppeteer-renderer) and implements it in Rust to leverage Rust's performance and safety features.
19+
20+
## Installation
21+
22+
### Prerequisites
23+
24+
- Rust 1.56+
25+
- Docker (optional, for containerized deployment)
26+
27+
### Clone the Repository
28+
29+
```bash
30+
git clone https://github.com/yourusername/renderer_rs.git
31+
cd renderer_rs
32+
cargo build --release
33+
```
34+
35+
## Docker Deployment
36+
37+
### Build and run the Docker container:
38+
39+
```bash
40+
docker build -t renderer_rs .
41+
docker run -p 8080:8080 renderer_rs
42+
```
43+
44+
## Usage
45+
46+
### Once the service is running, you can access the rendering service via the following URL:
47+
48+
```
49+
http://localhost:8080/html?url=http://www.google.com
50+
```
51+
52+
This URL will render the Google homepage and return the HTML content.
53+
54+
## Contributing
55+
56+
Contributions are welcome! Please submit a pull request or create an issue to discuss.

0 commit comments

Comments
 (0)