Flesh out GLoom
I have documented GLoom's new RPC, how a plugin developer might create a plugin, and more. I have also created GLoomI, the included management interface for GLoom and added a LICENSE.
This commit is contained in:
49
README.md
Normal file
49
README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# GLoom
|
||||
|
||||
GLoom is a plugin-based web server written in Go. GLoom's focus is to provide and simple and efficient way to host micro-web apps easily.
|
||||
|
||||
## Features
|
||||
|
||||
- Plugin-based architecture
|
||||
- RPC-based communication between GLoom and plugins
|
||||
- Built-in plugin management system
|
||||
- Built-in plugin management UI
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Go 1.20 or higher
|
||||
- [zqdgr](https://github.com/juls0730/zqdgr)
|
||||
|
||||
### Installation
|
||||
|
||||
1. Clone the repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/juls0730/gloom.git
|
||||
```
|
||||
|
||||
2. Run the project:
|
||||
|
||||
```bash
|
||||
zqdgr run
|
||||
```
|
||||
|
||||
or if you want to build the project:
|
||||
|
||||
```bash
|
||||
zqdgr build
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
please read [DOCUMENTATION.md](DOCUMENTATION.md)
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome!
|
||||
|
||||
## License
|
||||
|
||||
GLoom is licensed under the MIT License.
|
||||
Reference in New Issue
Block a user