Skip to content

Commit 6aca03e

Browse files
committed
feat. add readme
1 parent 8195ea0 commit 6aca03e

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Packaged
2+
Elegant and efficient Golang service management. Supports environment variable binding and service startup in a specified order.
3+
4+
### Features
5+
- **Service Management**: Organize and manage service startup in a predefined order.
6+
- **Environment Variable Binding**: Automatically bind services with environment variables to ensure proper configuration.
7+
- **Optimized for Efficiency**: Focused on performance and simplicity.
8+
- This package is a pure Go implementation with no third-party or C dependencies.
9+
10+
### Installation
11+
To install this package, run the following command:
12+
```shell
13+
go get github.com/RealFax/packaged
14+
```
15+
16+
### Usage
17+
1. **Setup Services**: Define the services you want to manage using this package.
18+
2. **Configure Environment Variables**: Bind necessary environment variables to each service.
19+
3. **Start Services**: Use the package to start services in the required order.
20+
21+
##### Example:
22+
see: [https://github.com/RealFax/packaged/tree/main/example](https://github.com/RealFax/packaged/tree/main/example)
23+
24+
### License
25+
This project is licensed under the GPL-3.0 License. See the [LICENSE](https://github.com/RealFax/packaged/blob/main/LICENSE) file for details.
26+
27+
28+
### Acknowledgments
29+
30+
<a href="https://jb.gg/OpenSourceSupport"><img width="100px" src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png"/></a>

0 commit comments

Comments
 (0)