Skip to content

Commit e33ccbd

Browse files
authored
Create README.md
1 parent 87e451f commit e33ccbd

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
```sh
30+
git clone https://github.com/yourusername/renderer_rs.git
31+
cd renderer_rs
32+
cargo build --release
33+
```

0 commit comments

Comments
 (0)