seed

README

seed

This repository contains seed files that almost every repository of Flamego middleware module should have.

Using the content

1. Create an empty repository on GitHub.com.
2. Download ZIP of this repository, unzip to a directory, then rename the directory to match the middleware name.
3. Update the Go module name in the go.mod file to match the middleware repository path, e.g.:

   -module github.com/flamego/seed
   +module github.com/flamego/bilibili
   

4. Update the package name in the main.go and rename the file to match the middleware name, e.g.:

   -package seed
   +package bilibili
   

5. Update the github.repository in the .github/workflows/lsif.yml to match the middleware repository, e.g.:

   -github.repository == 'flamego/seed'
   +github.repository == 'flamego/bilibili'
   

6. Update the import_root in the .deepsource.toml to match the middleware repository, e.g.:

   -import_root = "github.com/flamego/seed"
   +import_root = "github.com/flamego/bilibili"
   

7. Update the README.md to be about your middleware, a good example is flamego/template's README.

Getting help

• Please file an issue or start a discussion on the flamego/flamego repository.

License

This project is under the MIT License. See the LICENSE file for the full license text.