Skip to content

Commit

Permalink
update READMES of crates
Browse files Browse the repository at this point in the history
  • Loading branch information
glendc committed Nov 28, 2023
1 parent 2e4cd08 commit 1d75eac
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
3 changes: 3 additions & 0 deletions rama-rt-macros/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@

Macros for the runtime definitions and implementation in function of Rama.

This crate and its macros are not created to be used on itself. Please make use
of these macros by using `rama::rt::*` as part of your _rama_ usage. E.g. `rama::rt::main` and `rama::rt::test`.

> rama is early work in progress, use at your own risk.
>
> Not everything that exists is documented and not everything that is documented is implemented.
Expand Down
4 changes: 3 additions & 1 deletion rama-rt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,15 @@

Runtime definitions and implementation for Rama.

This crate is not created to be used on itself. Please make use
of this crate's functionality by using `rama::rt::*` as part of your _rama_ usage.

> rama is early work in progress, use at your own risk.
>
> Not everything that exists is documented and not everything that is documented is implemented.
Rama's full documentatuon can be found at <https://ramaproxy.org/>.


## Contributing

:balloon: Thanks for your help improving the project! We are so happy to have
Expand Down

0 comments on commit 1d75eac

Please sign in to comment.