diff --git a/.github/assets/rowix.png b/.github/assets/rowix.png new file mode 100755 index 0000000..02f3c4a Binary files /dev/null and b/.github/assets/rowix.png differ diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..9f4bc62 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,30 @@ +name: Release + +on: + push: + tags: + - '*' + +permissions: + contents: write + +jobs: + release: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: Set up Go + uses: actions/setup-go@v3 + with: + go-version: 1.18 + + - name: Run GoReleaser + uses: goreleaser/goreleaser-action@v3 + with: + distribution: goreleaser + workdir: . + args: release --rm-dist --config goreleaser.yml + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore index 397b4a7..8885b15 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ *.log +dist/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..84181a6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Aadhav Vignesh + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index ef2364c..160e5e1 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,27 @@ +![rowix banner](.github/assets/rowix.png) + # rowix A collaborative text editor written in Go. ## Usage +The easiest way to get started is to download `rowix` from the [releases](https://github.com/burntcarrot/rowix/releases). + +``` +Usage of rowix: + -login + Enable the login prompt + -path string + Server path (default "/") + -server string + Server network address (default "localhost:8080") + -wss + Enable a secure WebSocket connection +``` + +### Local setup + To start the server: ``` @@ -13,7 +31,7 @@ go run server/main.go To start the client: ``` -go run client/*.go +go run client/main.go ``` (spin up at least 2 clients - it's a collaborative editor! Also works with a single client.) @@ -33,4 +51,12 @@ Here's a basic explanation: - Rendering document contents - Handling key events - Generating payload on key presses - - Dispatch generated payload to the server + - Dispatching generated payload to the server + +## License + +`rowix` is licensed under the [MIT license](LICENSE). + +## Future plans + +Text editors is a huge space - there's lots of improvements to be made! diff --git a/goreleaser.yml b/goreleaser.yml new file mode 100644 index 0000000..83d48dd --- /dev/null +++ b/goreleaser.yml @@ -0,0 +1,31 @@ +project_name: rowix + +builds: + - id: "rowix-server" + main: ./server/main.go + binary: rowix-server + goos: + - linux + - darwin + - windows + - openbsd + goarch: + - amd64 + - arm64 + mod_timestamp: '{{ .CommitTimestamp }}' + env: + - CGO_ENABLED=0 + - id: "rowix-client" + main: ./client/main.go + binary: rowix + goos: + - linux + - darwin + - windows + - openbsd + goarch: + - amd64 + - arm64 + mod_timestamp: '{{ .CommitTimestamp }}' + env: + - CGO_ENABLED=0