Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Water-Melon committed Nov 2, 2023
1 parent e7aab13 commit 238942d
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,23 @@ Meproc is a process management service that can start, stop, and restart specifi



### Installation
## Installation

Meproc is written in [Melang](https://github.com/Water-Melon/Melang) language, which means that you need to install and only install Melang, then Meproc can be started up.

You can pull the built docker image.

```
docker pull melonc/meproc
```



### Quick Start
## Quick Start



##### Start Meproc
### Start Meproc

```bash
melang meproc.m
Expand All @@ -28,7 +34,7 @@ The default IP is `127.0.0.1` and port is `8606`.



##### Start process
### Start process

Here is a simple example.

Expand Down Expand Up @@ -70,7 +76,7 @@ This task will be executed every minute.



##### Stop process
### Stop process

Let's stop out `sleep1` task.

Expand All @@ -80,7 +86,7 @@ curl -v -XDELETE http://127.1:8606/proc?name=sleep1



##### Restart process
### Restart process

Let's restart task `sleep2`.

Expand All @@ -92,7 +98,7 @@ curl -v -XPOST http://127.1:8606/proc?name=sleep2



##### List all tasks and processes
### List all tasks and processes

```bash
curl -v -XGET http://127.1:8606/proc
Expand All @@ -102,7 +108,7 @@ An HTTP response with a JSON body will be returned.



##### Change configuration
### Change configuration

Configuration file is `conf.m`.

Expand All @@ -119,7 +125,7 @@ Conf = [



### Example
## Example

We start up Meproc, and run the commands that given below:

Expand Down Expand Up @@ -177,7 +183,7 @@ We will see the output of Meproc like:



### License
## License

[BSD-3-Clause License](https://github.com/Water-Melon/Melang/blob/master/LICENSE)

Expand Down

0 comments on commit 238942d

Please sign in to comment.