diff --git a/README.example.md b/README.example.md index 5daa3ec..c4deac7 100644 --- a/README.example.md +++ b/README.example.md @@ -1,12 +1,20 @@ + + + # MyRepository 📚 + + A template that gathers the minimal structure of my repository. ## 🚀 Features + + + - SIMPLE REST API - COOK APPLE PIE @@ -16,33 +24,57 @@ A template that gathers the minimal structure of my repository. brew install my-repository ``` + + + + + + + + + + + + + + + + + ### 🏗 Install from Source ```sh git clone https://github.com/HidemaruOwO/MyRepository.git cd MyRepository +# build command (e.g: go build, cargo build, pnpm run build) make -j8 -install -Dm0755 -t "/usr/local/bin/" "dist/builded-binary" +install -Dm0755 -t "dist/builded-binary" "/usr/local/bin/" ``` -- Arch Linux + -```sh -git clone https://github.com/HidemaruOwO/MyRepository.git -cd MyRepository + -makepkg -si -``` + + + + + + ## 🎯 Usage + + ```bash # running local host 3000 MyRepository ``` + + - To run the service automatically, you can set it up with `systemd`: ```sh