Skip to content

Commit 7cceed6

Browse files
committed

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,15 @@ and scale complex network behavior with safety and speed.
4646
It's not just a toolkit—it's a mindset shift for how
4747
to design and operate dynamic, programmable network services
4848

49-
> [!NOTE] The reasons behind the creation of Rama can be read in [the "Why Rama" chapter](https://ramaproxy.org/book/why_rama).
49+
> [!IMPORTANT]
50+
> The reasons behind the creation of Rama can be read in [the "Why Rama" chapter](https://ramaproxy.org/book/why_rama).
5051
5152
Rama is async-first using [Tokio](https://tokio.rs/) as its _only_ Async Runtime.
5253
Please refer to [the examples found in the `/examples` dir](https://github.com/plabayo/rama/tree/main/examples)
5354
to get inspired on how you can use it for your purposes.
5455

55-
> [!NOTE] This framework might not be for everyone. Particularly if you're building a typical simple web server
56+
> [!WARNING]
57+
> This framework might not be for everyone. Particularly if you're building a typical simple web server
5658
> or just need an HTTP client for making standard requests, you might be better served by other crates.
5759
> While we at [Plabayo](https://plabayo.tech) use Rama for most of our web needs (clients, servers, and proxies),
5860
> it is not the most straightforward framework to use and doesn't yet have the large community backing that other crates enjoy.
@@ -89,7 +91,8 @@ to get inspired on how you can use it for your purposes.
8991
[![Paypal Donation][paypal-badge]][paypal-url]
9092
[![Discord][discord-badge]][discord-url]
9193

92-
> [!NOTE] If your organization relies on Rama (ラマ) for its operations,
94+
> [!NOTE]
95+
> If your organization relies on Rama (ラマ) for its operations,
9396
> we invite you to consider becoming a sponsor 💖. By supporting our project,
9497
> you'll help ensure its continued development and success.
9598
> To learn more about sponsorship opportunities, please refer to [the "Sponsors" section below](#--sponsors)
@@ -135,7 +138,8 @@ The primary focus of Rama is to aid you in your development of [proxies](https:/
135138
- 🕵️‍♀️ [Distortion proxies](https://ramaproxy.org/book/proxies/distort).
136139
- 🧭 [HaProxy (PROXY protocol)](https://ramaproxy.org/book/proxies/haproxy).
137140

138-
> [!NOTE] Check out [the "Intro to Proxies" chapters in the Rama book](https://ramaproxy.org/book/proxies/intro.html)
141+
> [!TIP]
142+
> Check out [the "Intro to Proxies" chapters in the Rama book](https://ramaproxy.org/book/proxies/intro.html)
139143
> to learn more about the different kind of proxies. It might help in case you are new to developing proxies.
140144
141145
The [Distortion proxies](https://ramaproxy.org/book/proxies/distort) support
@@ -179,7 +183,8 @@ Next to proxies, Rama can also be used to develop [Web Services](#--web-services
179183
180184
💬 Come join us at [Discord][discord-url] on the `#rama` public channel. To ask questions, discuss ideas and ask how rama may be useful for you.
181185
182-
> [!NOTE] Rama also has a public channel on the official Discord of the tokio project.
186+
> [!NOTE]
187+
> Rama also has a public channel on the official Discord of the tokio project.
183188
> Feel free to join us there instead or as well: <https://discord.com/channels/500028886025895936/1349098858831024209>
184189
185190
## ⌨️ | `rama` binary
@@ -303,7 +308,9 @@ Examples of the kind of web services you might build with rama in function of yo
303308
- a minimal api service (e.g. to expose device profiles or certificates);
304309
- a graphical interface / control panel;
305310
306-
> [!NOTE] 📖 Learn more about developing web services in the Rama book: <https://ramaproxy.org/book/web_servers.html>.
311+
> [!TIP]
312+
> 📖 Learn more about developing web services
313+
> in the Rama book: <https://ramaproxy.org/book/web_servers.html>.
307314
308315
### Datastar
309316
@@ -370,7 +377,8 @@ This is the webservice behind the Rama fingerprinting service, which is used by
370377
the UA emulation data for the Http and TLS layers. It is not meant to fingerprint humans or users. Instead it is meant to help
371378
automated processes look like a human.
372379
373-
> [!NOTE] 💡 This example showcases how you can make use of the [`match_service`](https://docs.rs/rama-http/latest/rama_http/service/web/macro.match_service.html)
380+
> [!TIP]
381+
> This example showcases how you can make use of the [`match_service`](https://docs.rs/rama-http/latest/rama_http/service/web/macro.match_service.html)
374382
> macro to create a `Box`-free service router. Another example of this approach can be seen in the
375383
> [http_service_match.rs](https://github.com/plabayo/rama/tree/main/examples/http_service_match.rs) example.
376384
@@ -388,7 +396,9 @@ As a 🍒 cherry on the cake you can import the [`HttpClientExt`](https://ramapr
388396
389397
### 🧑‍💻 | Http Client Example
390398
391-
> [!NOTE] 💡 The full "high level" example can be found at [/examples/http_high_level_client.rs](https://github.com/plabayo/rama/tree/main/examples/http_high_level_client.rs).
399+
> [!TIP]
400+
> 💡 The full "high level" example can be found at
401+
> [/examples/http_high_level_client.rs](https://github.com/plabayo/rama/tree/main/examples/http_high_level_client.rs).
392402
393403
```rust
394404
use rama::http::service::client::HttpClientExt;
@@ -519,7 +529,8 @@ For that we thank you. You can take a look at the open issues, and in particular
519529
In general, any issue not assigned already is free to be picked up by anyone else. Please do communicate in the ticket
520530
if you are planning to pick it up, as to avoid multiple people trying to solve the same one.
521531
522-
> [!NOTE] 💡 Some issues have a [`needs input`](https://github.com/plabayo/rama/issues?q=is%3Aissue+is%3Aopen+label%3A%22needs+input%22+) label.
532+
> [!NOTE]
533+
> Some issues have a [`needs input`](https://github.com/plabayo/rama/issues?q=is%3Aissue+is%3Aopen+label%3A%22needs+input%22+) label.
523534
> These mean that the issue is not yet ready for development. First of all prior to starting working on an issue you should always look for
524535
> alignment with the rama maintainers. However these
525536
> [`needs input`](https://github.com/plabayo/rama/issues?q=is%3Aissue+is%3Aopen+label%3A%22needs+input%22+) issues require also prior R&D work:

0 commit comments

Comments
 (0)