Create documentation for .air.toml

air-verse / air

☁️ Live reload for Go apps

GNU General Public License v3.0

16.38k stars 772 forks source link

Create documentation for .air.toml #466

Open andradei opened 10 months ago

andradei commented 10 months ago

Request to add documentation for the options that go inside .air.toml

On the air --help CLI option
On the README.md of the reposiroty
Preferably both

valxntine commented 9 months ago

There is an air_example.toml in the repo here, is that not enough?

andradei commented 9 months ago

It's definitely helpful, and --help or a man entrance for local/offline reference would be great.

xiantang commented 8 months ago

I think it's good but for now we use air_example.toml as document, but if we introduce the --help then we need to maintain to place of document, we need to follow DRY rule.

andradei commented 8 months ago

@xiantang if the air_example.toml is available offline, that would be great. Otherwise, having a --help or man page is superior to an example file on the repository as far as a self-sufficient tool goes. Of course, users can copy the file or the entire repo so they have it locally. That's overkill though.