Skip to content

Commit

Permalink
rephrase readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
ehsannm committed May 24, 2024
1 parent 8747134 commit 33112aa
Show file tree
Hide file tree
Showing 6 changed files with 399 additions and 332 deletions.
37 changes: 17 additions & 20 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,29 +1,26 @@
# RonyKIT

RonyKIT is a set of tools that are designed to be extendable and flexible to write a complete API/Edge server quickly.
When you develop API handlers using RonyKIT framework, you can support RPC and REST style APIs without re-writing the
RonyKIT is a collection of tools designed to be both extendable and flexible, enabling the rapid development of a complete API/Edge server.
With the RonyKIT framework, you can create API handlers that support both RPC and REST style APIs without the need to rewrite the
endpoint layer multiple times.

If you are looking for a framework to write your API/Edge server, you can use `rony` package directly, which provides
an easy-to-use framework and with help of Go Generics, it provides a very clean and easy to use API. This is the
recommended way to use RonyKIT framework. However, if you want to have more control over your API server, and are
very concern about performance and memory usage, you can use `kit` package directly, which is the heart of the RonyKIT
framework.
If you are seeking a framework to develop your API/Edge server, you can directly use the `rony` package. This package provides an
intuitive framework, leveraging Go Generics to offer a clean and user-friendly API. This is the recommended approach for using
the RonyKIT framework. However, if you require greater control over your API server and have concerns about performance and
memory usage, you can directly utilize the `kit` package, which forms the core of the RonyKIT framework.

- For more information about `rony` package, please visit [rony](./rony/README.MD)
- For more information about `kit` package, please visit [kit](./kit/README.MD)
- For more information about the `rony` package, please visit [rony](./rony/README.MD).
- For more information about the `kit` package, please visit [kit](./kit/README.MD).

# RonyKIT Standard Packages

This repository is holding all the projects related to RonyKIT. The main package which is the heart of
the RonyKIT framework is [kit](./kit) and the standard modules are in the /std folders.

| Package | BundleType | Version | Description |
|--------------|------------|---------|--------------------------------------------------------------------------------------------------------------------------------------|
| KIT | - | v0.14.0 | the main package of the RonyKIT framework |
| fasthttp | Gateway | v0.14.0 | the Gateway bundle implemented using [fasthttp](https://github.com/valyala/fasthttp) framework |
| fastws | Gateway | v0.14.0 | the Gateway bundle implemented using [gnet](https://github.com/panjf2000/gnet) and [gobwas](https://github.com/gobwas/ws) frameworks |
| silverhttp | Gateway | v0.14.0 | the Gateway bundle implemented using the new kid super-fast http server [silverlining](https://github.com/go-www/silverlining) |
| rediscluster | Cluster | v0.14.0 | the Cluster bundle implemented using [redis](https://github.com/go-redis/redis) |
| p2pcluster | Cluster | v0.14.0 | the Cluster bundle implemented using [p2p](https://github.com/libp2p/go-libp2p) | |
This repository contains all projects related to RonyKIT. The central package, which is the core of the RonyKIT framework, is [kit](./kit), with standard modules located in the /std folders.

| Package | Bundle Type | Version | Description |
|--------------|-------------|---------|--------------------------------------------------------------------------------------------------------------------------------------|
| KIT | - | v0.14.0 | The main package of the RonyKIT framework |
| fasthttp | Gateway | v0.14.0 | The Gateway bundle implemented using the [fasthttp](https://github.com/valyala/fasthttp) framework |
| fastws | Gateway | v0.14.0 | The Gateway bundle implemented using [gnet](https://github.com/panjf2000/gnet) and [gobwas](https://github.com/gobwas/ws) frameworks |
| silverhttp | Gateway | v0.14.0 | The Gateway bundle implemented using the new super-fast HTTP server [silverlining](https://github.com/go-www/silverlining) |
| rediscluster | Cluster | v0.14.0 | The Cluster bundle implemented using [redis](https://github.com/go-redis/redis) |
| p2pcluster | Cluster | v0.14.0 | The Cluster bundle implemented using [p2p](https://github.com/libp2p/go-libp2p) |
8 changes: 4 additions & 4 deletions example/README.MD
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Examples
This directory contains some examples to show how to use the ronykit library. The first four
examples use the `kit` package directly and the rest use the `rony` package.

Examples are short and simple to understand. They are not meant to be used in production, they just
show how to use the library.
This directory houses several examples showcasing the usage of the ronykit library. The initial four examples
utilize the `kit` package directly, while the subsequent ones utilize the `rony` package. These examples are
designed to be concise and straightforward, aimed at illustrating how to utilize the library's functionalities.
They are not intended for production use but rather serve as instructional aids.
Loading

0 comments on commit 33112aa

Please sign in to comment.