chore: improved README.md

saskenuba · saskenuba · commit 29f6f6a04c2b · 2022-03-03T11:48:51.000-03:00
Signed-off-by: Martin &lt;martin@hotmail.com.br&gt;
diff --git a/README.md b/README.md
@@ -1,19 +1,44 @@
 # actix-prerender
 
 A simple middleware that sends HTTP requests from known crawlers user-agents to
-be rendered by an external prerender service URL or
+render as HTML by an external prerender service URL such as
+[tvanro/prerender-alpine](https://hub.docker.com/r/tvanro/prerender-alpine
+"docker hub image"), or from the service from the creators
 [prerender.io](https://prerender.io "Prerender.io website").
 
+Useful to websites with tons of javascript, such as SPAs like Vue.js or React
+among others.
+
 ## Usage
 
+
+### Prerender.io example
 ```rust
-```
 
+ use actix_prerender::Prerender;
+ use actix_web::http::header;
+
+ let token = "prerender service token".to_string();
+ let prerender = Prerender::build().use_prerender_io(token);
+
+ // `prerender` can now be used in `App::wrap`.
+ ```
+
+### Custom service URL example
+```rust
+use actix_prerender::Prerender;
+use actix_web::http::header;
+
+let token = "prerender service token".to_string();
+let prerender = Prerender::build().use_custom_prerender_url("https://localhost:5001");
+
+// `prerender` can now be used in `App::wrap`.
+```
 
 ## Installation
 
 Add this into your `Cargo.toml`
 
 ```toml
-actix-prerender = { git = "https://github.com/saskenuba/actix-prerender" }
+actix-prerender = "0.2"
 ```
