gob icon indicating copy to clipboard operation
gob copied to clipboard

Documentation and examples

Open b1lly opened this issue 11 years ago • 2 comments

As a developer, I'd like the project to be well documented so that it makes it easier to understand and contribute to.

Additionally, as a user, I'd like all the various use cases documented so that using the CLI has smaller barrier to entry.

b1lly avatar Apr 06 '14 16:04 b1lly

Perhaps better examples could remedy a lot of this? Both examples of a session with gob and ways to write the config file or have gob make it for you?

ttacon avatar Apr 06 '14 17:04 ttacon

Yeah definitely, I totally agree that better examples would be fine for a lot of this. The documentation/examples should cator to both people using Gob from the CLI and people using gob to integrate with their frameworks (e.g. if Martini wanted hot-reload to be included as a core feature)

b1lly avatar Apr 07 '14 00:04 b1lly