Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Eslam-Nawara authored Dec 19, 2022
1 parent 972843a commit 81593da
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,13 @@ redis:
- **Get the pkg:**
```go get https://github.com/Eslam-Nawara/foreman```
- **pkg API:**
- **Package API:**
|Function | Description |
| :--- | :--- |
| ``func New(procfilePath string, isVerbose bool) (*Foreman, error)`` | Builds a new instance of foreman from a given procfile. |
| ``func (f *Foreman) Start() error`` | Starts the foreman services parsed from the procfile. |
| ``func (f *Foreman) Exit(exitStatus int)`` | Terminates all the foreman services. |

## Usage and installation:
- **Install the pkg**
```go install https://github.com/Eslam-Nawara/foreman```
Expand Down

0 comments on commit 81593da

Please sign in to comment.