From 81593dacedacceb836fcc6892bf1c7ca16ac5d25 Mon Sep 17 00:00:00 2001 From: Eslam_Nawara <67752395+Eslam-Nawara@users.noreply.github.com> Date: Mon, 19 Dec 2022 17:11:19 +0200 Subject: [PATCH] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index df009ed..10e6c70 100755 --- a/README.md +++ b/README.md @@ -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```