Merge pull request #117 from nao1215/homebrew

Introduce Homebrew

.all-contributorsrc

@@ -0,0 +1,43 @@
+{
+  "projectName": "mimixbox",
+  "projectOwner": "nao1215",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 75,
+  "commit": true,
+  "commitConvention": "angular",
+  "contributors": [
+    {
+      "login": "nao1215",
+      "name": "CHIKAMATSU Naohiro",
+      "avatar_url": "https://avatars.githubusercontent.com/u/22737008?v=4",
+      "profile": "https://debimate.jp/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "polynomialspace",
+      "name": "polynomialspace",
+      "avatar_url": "https://avatars.githubusercontent.com/u/45617594?v=4",
+      "profile": "https://github.com/polynomialspace",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "k-avy",
+      "name": "Kavya Shukla",
+      "avatar_url": "https://avatars.githubusercontent.com/u/81437739?v=4",
+      "profile": "https://github.com/k-avy",
+      "contributions": [
+        "code"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "linkToUsage": true
+}

.github/dependabot.yml

@@ -6,3 +6,8 @@ updates:
       interval: daily
       time: "20:00"
     open-pull-requests-limit: 10
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/build.yml

@@ -13,9 +13,10 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v5
         with:
-          go-version: "1.18"
+          go-version: "1"
+          check-latest: true
 
       - name: Build
         run: make build

.github/workflows/integration_test.yml

@@ -14,9 +14,10 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v5
         with:
-          go-version: "1.18"
+          go-version: "1"
+          check-latest: true
 
       - name: SetupShellScript
         run: curl -fsSL https://git.io/shellspec | sh -s -- --yes

.github/workflows/release.yml

@@ -15,9 +15,10 @@ jobs:
         with:
           fetch-depth: 0
       - name: Setup Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v5
         with:
-          go-version: "1.18"
+          go-version: "1"
+          check-latest: true
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v2
         with:

.github/workflows/unit_test.yml

@@ -12,10 +12,10 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Set up Go
-        uses: actions/setup-go@v2
+      - uses: actions/setup-go@v5
         with:
-          go-version: "1.18"
+          go-version: "1"
+          check-latest: true
 
       - name: UnitTest
         run: make ut

.goreleaser.yml

@@ -13,12 +13,16 @@ builds:
       - CGO_ENABLED=0
     goos:
       - linux
+      - windows
+      - darwin
+    goarch:
+      - amd64
+      - arm64
 archives:
   - name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
-    replacements:
-      linux: Linux
-      386: i386
-      amd64: x86_64
+    format_overrides:
+      - goos: windows
+        format: zip
 checksum:
   name_template: "checksums.txt"
 snapshot:
@@ -29,3 +33,20 @@ changelog:
     exclude:
       - "^docs:"
       - "^test:"
+nfpms:
+  - maintainer: Naohiro CHIKAMATSU <n.chika156@gmail.com>
+    description: MimixBox - mimic BusyBox on Linux
+    homepage: https://github.com/nao1215/mimixbox
+    license: Apache-2.0 license
+    formats:
+      - deb
+      - rpm
+      - apk
+brews:
+  - name: mimixbox
+    description: MimixBox - mimic BusyBox on Linux
+    license: Apache-2.0 license
+    repository:
+      owner: nao1215
+      name: homebrew-tap
+      token: "{{ .Env.TAP_GITHUB_TOKEN }}"

README.md

@@ -1,4 +1,7 @@
 <div align="center">
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
 <img src="https://github.com/nao1215/mimixbox/blob/main/docs/images/logo.jpg" width="100">
 </div>
 
@@ -19,18 +22,18 @@ Also, the MimixBox project maintainer plan to have a wide range of built-in comm
 The source code and binaries are distributed on [the Release Page](https://github.com/nao1215/mimixbox/releases) in ZIP format and tar.gz format. Choose the binary that suits your OS and CPU architecture.
 For example, in the case of Linux (amd64), you can install the MimixBox and documents on your system with the following command:
 
-```
+```shell
 $ tar xf mimixbox-0.30.0-linux-amd64.tar.gz
 $ cd mimixbox-0.30.0-linux-amd64
 $ sudo ./installer.sh
 ```
 
-If you have a Golang development environment, you can also install it by the following method. This method does not install the documentation.
-
-```
+## Use "go install" 
+```shell
 $ go install github.com/nao1215/mimixbox/cmd/mimixbox@latest
 $ sudo mimixbox --install /usr/local/bin
 ```
+
 # Development 
 ## Tools & Libraries
 The table below shows the tools used when developing the commands in the MimixBox project.
@@ -118,3 +121,36 @@ We are also looking forward to sponsorship.
 # LICENSE
 The MimixBox project is licensed under the terms of the MIT license and Apache License 2.0.  
 See [LICENSE](./LICENSE) and [NOTICE](./NOTICE)
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://debimate.jp/"><img src="https://avatars.githubusercontent.com/u/22737008?v=4?s=75" width="75px;" alt="CHIKAMATSU Naohiro"/><br /><sub><b>CHIKAMATSU Naohiro</b></sub></a><br /><a href="https://github.com/nao1215/mimixbox/commits?author=nao1215" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/polynomialspace"><img src="https://avatars.githubusercontent.com/u/45617594?v=4?s=75" width="75px;" alt="polynomialspace"/><br /><sub><b>polynomialspace</b></sub></a><br /><a href="https://github.com/nao1215/mimixbox/commits?author=polynomialspace" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/k-avy"><img src="https://avatars.githubusercontent.com/u/81437739?v=4?s=75" width="75px;" alt="Kavya Shukla"/><br /><sub><b>Kavya Shukla</b></sub></a><br /><a href="https://github.com/nao1215/mimixbox/commits?author=k-avy" title="Code">💻</a></td>
+    </tr>
+  </tbody>
+  <tfoot>
+    <tr>
+      <td align="center" size="13px" colspan="7">
+        <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
+          <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
+        </img>
+      </td>
+    </tr>
+  </tfoot>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!