Merge pull request #65 from sgtm-club/dev/moul/migrate-repo-update-doc

feat: migrate the repo to sgtm-club org + update doc

.goreleaser.yml

@@ -59,12 +59,12 @@ brews:
     commit_author:
       name: moul-bot
       email: "[email protected]"
-    homepage: https://github.com/moul/sgtm
+    homepage: https://github.com/sgtm-club/sgtm
     description: "sgtm"
 nfpms:
   -
     file_name_template: '{{ .ProjectName }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}'
-    homepage:  https://github.com/moul/sgtm
+    homepage:  https://github.com/sgtm-club/sgtm
     description: "sgtm"
     maintainer: "Manfred Touron <https://manfred.life>"
     license: "Apache-2.0 OR MIT"

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing
+
+## Discuss
+
+You don't need to be a developer to help us improving SGTM; Feel free to start a discussion if you have an idea, an advice or if you want to share any resource that can help us make the product better.
+
+## Develop
+
+The project is probably(?) `go-gettable` with `go get moul.io/sgtm`; but we strongly suggest you to clone the repo somewhere and use the provided Makefile.
+
+```bash
+git clone https://github.com/sgtm-club/sgtm
+cd sgtm
+make run
+```
+
+You will probably need to provide some tokens in a `config.txt` file or by passing command-line arguments.
+
+Please, open an issue if you need help for setting-up your development environment.
+
+## Translate the app
+
+*TODO*

Dockerfile

@@ -36,11 +36,11 @@ LABEL           org.label-schema.build-date=$BUILD_DATE \
                 org.label-schema.description="" \
                 org.label-schema.url="https://moul.io/sgtm/" \
                 org.label-schema.vcs-ref=$VCS_REF \
-                org.label-schema.vcs-url="https://github.com/moul/sgtm" \
+                org.label-schema.vcs-url="https://github.com/sgtm-club/sgtm" \
                 org.label-schema.vendor="Manfred Touron" \
                 org.label-schema.version=$VERSION \
                 org.label-schema.schema-version="1.0" \
-                org.label-schema.cmd="docker run -i -t --rm moul/sgtm" \
+                org.label-schema.cmd="docker run -i -t --rm sgtm-club/sgtm" \
                 org.label-schema.help="docker exec -it $CONTAINER sgtm --help"
 COPY            --from=builder /go/bin/sgtm /bin/
 ENTRYPOINT      ["/bin/sgtm"]

README.md

@@ -1,42 +1,49 @@
-# sgtm
+# SGTM - Sounds good to me!
 
-:smile: sgtm
+:+1: An ongoing-song sharing platform for musicians.
 
-![CI](https://github.com/moul/sgtm/workflows/CI/badge.svg)
+Share your work early, get feedback from other musicians, be more productive, learn new things.
+
+![CI](https://github.com/sgtm-club/sgtm/workflows/CI/badge.svg)
 [![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/moul.io/sgtm)
-[![License](https://img.shields.io/badge/license-Apache--2.0%20%2F%20MIT-%2397ca00.svg)](https://github.com/moul/sgtm/blob/master/COPYRIGHT)
-[![GitHub release](https://img.shields.io/github/release/moul/sgtm.svg)](https://github.com/moul/sgtm/releases)
+[![License](https://img.shields.io/badge/license-Apache--2.0%20%2F%20MIT-%2397ca00.svg)](https://github.com/sgtm-club/sgtm/blob/master/COPYRIGHT)
+[![GitHub release](https://img.shields.io/github/release/sgtm-club/sgtm.svg)](https://github.com/sgtm-club/sgtm/releases)
 [![Go Report Card](https://goreportcard.com/badge/moul.io/sgtm)](https://goreportcard.com/report/moul.io/sgtm)
-[![CodeFactor](https://www.codefactor.io/repository/github/moul/sgtm/badge)](https://www.codefactor.io/repository/github/moul/sgtm)
-[![codecov](https://codecov.io/gh/moul/sgtm/branch/master/graph/badge.svg)](https://codecov.io/gh/moul/sgtm)
+[![CodeFactor](https://www.codefactor.io/repository/github/sgtm-club/sgtm/badge)](https://www.codefactor.io/repository/github/sgtm-club/sgtm)
+[![codecov](https://codecov.io/gh/sgtm-club/sgtm/branch/master/graph/badge.svg)](https://codecov.io/gh/sgtm-club/sgtm)
 [![Docker Metrics](https://images.microbadger.com/badges/image/moul/sgtm.svg)](https://microbadger.com/images/moul/sgtm)
-[![GolangCI](https://golangci.com/badges/github.com/moul/sgtm.svg)](https://golangci.com/r/github.com/moul/sgtm)
-[![Made by Manfred Touron](https://img.shields.io/badge/made%20by-Manfred%20Touron-blue.svg?style=flat)](https://manfred.life/)
+[![GolangCI](https://golangci.com/badges/github.com/sgtm-club/sgtm.svg)](https://golangci.com/r/github.com/sgtm-club/sgtm)
 
+[Sounds good to me](https://sgtm.club) is a platform made by developers making music.
+The platform aims to provide an experience similar to what developers can find with modern collaboration tools, such as Git and GitHub.
 
-## Usage
+## Philosophy
 
 TODO
 
-## Install
+## Contributing
 
-### Using go
+We really welcome contributions. Your input is the most precious material. We're well aware of that and we thank you in advance. Everyone is encouraged to look at what they can do on their own scale; no effort is too small.
 
-```console
-$ go get -u moul.io/sgtm
-```
+Everything on contribution is sum up here: [CONTRIBUTING.MD](./CONTRIBUTING.MD).
 
-### Releases
+## Links & Resources
 
-See https://github.com/moul/sgtm/releases
+* [Official Website: https://sgtm.club](https://sgtm.club)
+* [`/open`: Open Startup](https://sgtm.club/open)
+* [Open-Roadmap on Trello](https://trello.com/b/kEb17Beb)
+* [`sgtm-club` GitHub organization](https://github.com/sgtm-club)
+* Created by [Manfred Touron](https://manfred.life)
+* Help & Support: click on the chat button at the bottom-right of sgtm or [fill an issue](https://github.com/sgtm-club/sgtm/issues)
+* [Join the Discord](https://discord.gg/bMjFtACYp3) _(not yet widely used, but we need to start somewhere :p)_
 
 ## Stargazers over time
 
-[![Stargazers over time](https://starchart.cc/moul/sgtm.svg)](https://starchart.cc/moul/sgtm)
+[![Stargazers over time](https://starchart.cc/sgtm-club/sgtm.svg)](https://starchart.cc/sgtm-club/sgtm)
 
 ## License
 
-© 2020 [Manfred Touron](https://manfred.life)
+© 2020 [Manfred Touron](https://manfred.life) and other contributors.
 
 Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) ([`LICENSE-APACHE`](LICENSE-APACHE)) or the [MIT license](https://opensource.org/licenses/MIT) ([`LICENSE-MIT`](LICENSE-MIT)), at your option. See the [`COPYRIGHT`](COPYRIGHT) file for more details.