search

guedes / pgxn-utils

A set of task that help developers to create PostgreSQL's extensions
http://pgxn.org
Other
37 stars 15 forks source link

README editing. #26

Closed theory closed 12 years ago

theory commented 13 years ago

In response to your request for a proof.

One comment: In most of the example commands, you include the name of the extension. Is it not the case that if you run the tasks in the extension root directory, you don't have to do that? That is, it assumes the current directory? If so, I think that should be spelled-out, as well.

Also, I've noticed that when I do that, pgxn-utils bundle puts the zip file in the parent directory. Took me a few minutes to find it. I think it should just be created in the current directory, or else there should be a message saying where to find it. Furthermore, I think that pgxn release should know where to find it, too (which, if it was in the current directory, would be simple).

And finally, I suggest you move this file into docs/pgxn-utils.md or similar, add a docfile key to provides:pgxn_utils that points at it, and then make the README.md more generic. I'm thinking like semver, where the README has installation and license information, and the doc/semver.mmd file is the usage documentation. Thoughts?

Thanks agin for this, looks great!

Oh, one more thing: How about mentioning the integration with the pgxn command-line client?

guedes commented 12 years ago

Thank you @theory ! I'll improve the docs as you suggested.