Skip to content

Commit 4c3245d

Browse files
committed
improve docs further
1 parent 3d99ad6 commit 4c3245d

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,11 @@ Whether you're intercepting traffic for security analysis, writing a web service
5757
emulating clients with custom user agents, hijacking connections for advanced testing, or building high-performance proxies, rama provides a clean and composable [Tokio](https://tokio.rs/)-native foundation to program network services in Rust.
5858

5959
It's not just a toolkit—it's a mindset shift for how
60-
to design and operate dynamic, programmable network services
60+
to design and operate dynamic, programmable network services.
61+
62+
Network protocols supported and implemented by rama allow you to build servers,
63+
clients and proxies.
64+
6165

6266
[![GitHub Sponsors][ghs-badge]][ghs-url]
6367
[![Buy Me A Coffee][bmac-badge]][bmac-url]
@@ -73,8 +77,8 @@ Read further below or skip to one of the following chapters instead:
7377
- [Who is rama for](#who-is-rama-for)
7478
- [For organisations](#for-organisations)
7579
- [Experimental](#--experimental)
76-
- [Proxies and use cases](#-roxies-and-other-use-cases)
77-
- [rama binary](#--rama-binary)
80+
- [Proxies and other use cases](#-proxies-and-other-use-cases)
81+
- [rama binary](#rama-binary)
7882
- [rama ecosystem](#--rama-ecosystem)
7983
- [rama crates](#--rama-crates)
8084
- [Web Services](#--web-services)
@@ -84,7 +88,6 @@ Read further below or skip to one of the following chapters instead:
8488
- [Compatibility](#--compatibility)
8589
- [Minimum supported Rust version](#minimum-supported-rust-version)
8690
- [Roadmap](#--roadmap)
87-
- [Contributing](#--contributing)
8891

8992
## Who is rama for
9093

@@ -115,7 +118,7 @@ middleware, services and stacks you'll build yourself:
115118
| ✅ Diagnostics |[curl export](https://ramaproxy.org/docs/rama/http/convert/curl/index.html) ⸱ ✅ [HAR](https://ramaproxy.org/docs/rama/http/layer/har/index.html) |
116119
| ✅ upstream [proxies](https://ramaproxy.org/docs/rama/proxy/index.html) |[MemoryProxyDB](https://ramaproxy.org/docs/rama/proxy/struct.MemoryProxyDB.html) ⸱ ✅ [Username Config](https://ramaproxy.org/docs/rama/username/index.html) ⸱ ✅ [Proxy Filters](https://ramaproxy.org/docs/rama/proxy/struct.ProxyFilter.html) |
117120
|[User Agent (UA)](https://ramaproxy.org/book/intro/user_agent) |[Http Emulation](https://ramaproxy.org/docs/rama/ua/profile/struct.HttpProfile.html) ⸱ ✅ [Tls Emulation](https://ramaproxy.org/docs/rama/ua/profile/struct.TlsProfile.html) ⸱ ✅ [UA Parsing](https://ramaproxy.org/docs/rama/ua/struct.UserAgent.html) |
118-
|[Fingerprinting](https://ramaproxy.org/docs/rama/net/fingerprint/index.html) |[Ja3](https://ramaproxy.org/docs/rama/net/fingerprint/struct.Ja3.html) ⸱ ✅ [Ja4](https://ramaproxy.org/docs/rama/net/fingerprint/struct.Ja4.html) ⸱ ✅ [Ja4H](https://ramaproxy.org/docs/rama/net/fingerprint/struct.Ja4H.html)🏗️ [Akamai passive h2](https://github.com/plabayo/rama/issues/517) <sup>(1)</sup> ⸱ ✅ [Peetprint (tls)](https://ramaproxy.org/docs/rama/net/fingerprint/struct.PeetPrint.html) |
121+
|[Fingerprinting](https://ramaproxy.org/docs/rama/net/fingerprint/index.html) |[Ja3](https://ramaproxy.org/docs/rama/net/fingerprint/struct.Ja3.html) ⸱ ✅ [Ja4](https://ramaproxy.org/docs/rama/net/fingerprint/struct.Ja4.html) ⸱ ✅ [Ja4H](https://ramaproxy.org/docs/rama/net/fingerprint/struct.Ja4H.html) [Akamai passive h2](https://ramaproxy.org/docs/rama/net/fingerprint/struct.AkamaiH2.html) ⸱ ✅ [Peetprint (tls)](https://ramaproxy.org/docs/rama/net/fingerprint/struct.PeetPrint.html) |
119122
| ✅ utilities |[error handling](https://ramaproxy.org/docs/rama/error/index.html) ⸱ ✅ [graceful shutdown](https://ramaproxy.org/docs/rama/graceful/index.html) ⸱ ✅ [Connection Pooling](https://ramaproxy.org/docs/rama/net/client/pool/index.html) ⸱ ✅ [Tower Adapter](https://ramaproxy.org/docs/rama/utils/tower/index.html) ⸱ 🏗️ IP2Loc <sup>(1)</sup> |
120123
| 🏗️ Graphical Interface | 🏗️ traffic logger <sup>(3)</sup> ⸱ 🏗️ [TUI implementation](https://ratatui.rs/) <sup>(3)</sup> ⸱ ❌ traffic intercept <sup>(3)</sup> ⸱ ❌ traffic replay <sup>(3)</sup> |
121124
| ✅ binary |[prebuilt binaries](https://ramaproxy.org/book/deploy/rama-cli) ⸱ 🏗️ proxy config <sup>(3)</sup> ⸱ ✅ http client ⸱ ❌ WASM Plugins <sup>(3)</sup> |
@@ -228,7 +231,7 @@ Next to proxies, rama can also be used to develop [Web Services](#--web-services
228231
> rama also has a public channel on the official Discord of the tokio project.
229232
> Feel free to join us there instead or as well: <https://discord.com/channels/500028886025895936/1349098858831024209>
230233
231-
## ⌨️ | rama binary
234+
## rama binary
232235
233236
The `rama` binary allows you to use a lot of what `rama` has to offer without
234237
having to code yourself. It comes with a working http client for CLI, which emulates
@@ -316,7 +319,9 @@ Repositories that we maintain and are re exported by the root `rama` crate:
316319
## 🌐 | Web Services
317320
318321
> [!TIP]
319-
> See all HTTP(S) server examples at <https://github.com/plabayo/rama/tree/main/examples#http-servers-and-services>.
322+
> See all HTTP(S) server examples at:
323+
>
324+
> <https://github.com/plabayo/rama/tree/main/examples#http-servers-and-services>
320325
>
321326
> On that README you also find other kind of server examples listed.
322327
@@ -346,6 +351,8 @@ Even when building proxies a (local/private) web service can often still be usef
346351
> 📖 Learn more about developing web services
347352
> in the rama book: <https://ramaproxy.org/book/web_servers.html>.
348353
354+
Next to https clients you can use any other protocol supported by Rama as a client.
355+
349356
### Datastar
350357
351358
> Datastar helps you build reactive web applications with the simplicity of server-side rendering and the power of a full-stack SPA framework.

docs/index.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -478,9 +478,8 @@ <h3>Fingerprinting</h3>
478478
href="https://ramaproxy.org/docs/rama/net/fingerprint/struct.Ja4.html">Ja4</a></li>
479479
<li><span class="feature-status status-done"></span><a
480480
href="https://ramaproxy.org/docs/rama/net/fingerprint/struct.Ja4H.html">Ja4H</a></li>
481-
<li><span class="feature-status status-wip">🏗️</span><a
482-
href="https://github.com/plabayo/rama/issues/517">Akamai passive h2</a> <sup><a
483-
href="#footnote-1">1</a></sup></li>
481+
<li><span class="feature-status status-done"></span><a
482+
href="https://ramaproxy.org/docs/rama/net/fingerprint/struct.AkamaiH2.html">Akamai passive h2</a></li>
484483
<li><span class="feature-status status-done"></span><a
485484
href="https://ramaproxy.org/docs/rama/net/fingerprint/struct.PeetPrint.html">Peetprint (tls)</a></li>
486485
</ul>

0 commit comments

Comments
 (0)