Update README with files to edit manually (#133)

Co-authored-by: Alejandro García Montoro <alejandro.garciamontoro@gmail.com>
This commit is contained in:
moussetc 2020-10-16 13:01:54 +02:00 committed by GitHub
parent 95bcc7ac80
commit d3786e75dd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -14,7 +14,8 @@ git clone --depth 1 https://github.com/mattermost/mattermost-plugin-starter-temp
Note that this project uses [Go modules](https://github.com/golang/go/wiki/Modules). Be sure to locate the project outside of `$GOPATH`. Note that this project uses [Go modules](https://github.com/golang/go/wiki/Modules). Be sure to locate the project outside of `$GOPATH`.
Edit `plugin.json` with your `id`, `name`, and `description`: Edit the following files:
1. `plugin.json` with your `id`, `name`, and `description`:
``` ```
{ {
"id": "com.example.my-plugin", "id": "com.example.my-plugin",
@ -23,6 +24,19 @@ Edit `plugin.json` with your `id`, `name`, and `description`:
} }
``` ```
2. `go.mod` with your Go module path, following the `<hosting-site>/<repository>/<module>` convention:
```
module github.com/example/my-plugin
```
3. `.golangci.yml` with your Go module path:
```yml
linters-settings:
# [...]
goimports:
local-prefixes: github.com/example/my-plugin
```
Build your plugin: Build your plugin:
``` ```
make make