Permalink
Browse files

fixing README

  • Loading branch information...
1 parent f469625 commit dc6aa9910960a95ad006418c3f16bd3acb0945c2 @guedes committed Apr 15, 2012
Showing with 12 additions and 21 deletions.
  1. +12 −21 README.md
View
@@ -32,8 +32,6 @@ It is all about tasks. Let's see them:
pgxn-utils help [TASK] # Describe available tasks or one specific task
pgxn-utils release filename # Release an extension to PGXN
pgxn-utils skeleton extension_name # Create an extension skeleton in current directory
-
-
# Creating a new extension
@@ -76,8 +74,6 @@ use `--git` option in the skeleton task.
init /tmp/my_cool_versioned_extension
commit initial commit
-
-
When you create a new extension with git support in addition to creating the skeleton,
`pgxn-utils` will initialize a git repository and create the initial commit.
@@ -110,8 +106,6 @@ modules or you will create a FDW, you can create the extension calling `skeleton
create my_cool_c_extension/test/expected/base.out
create my_cool_c_extension/test/sql/base.sql
-
-
$ pgxn-utils skeleton my_cool_fdw_extension --template=fdw
create my_cool_fdw_extension
create my_cool_fdw_extension/my_cool_fdw_extension.control
@@ -127,7 +121,6 @@ modules or you will create a FDW, you can create the extension calling `skeleton
create my_cool_fdw_extension/test/expected/base.out
create my_cool_fdw_extension/test/sql/base.sql
-
The templates contain example code and some links to PostgreSQL documentation
that will try to help you to start coding. SQL and C templates contains some test
examples, and the example code will compile and pass `make installcheck`.
@@ -180,15 +173,14 @@ Suppose you want to change the default maintainer's name and the license, just d
force META.json
identical my_cool_extension.control
-
It will wait until you decide what to do.
For all switches that you can use with *change*, type:
$ pgxn-utils help change
Usage:
pgxn-utils change [extension_name]
-
+
Options:
-p, [--target=TARGET] # Define the target directory
# Default: .
@@ -200,9 +192,8 @@ For all switches that you can use with *change*, type:
-b, [--generated-by=GENERATED_BY] # Name of extension's generator
-t, [--tags=one two three] # Defines extension's tags
-r, [--release-status=RELEASE_STATUS] # Initial extension's release status
-
- Changes META's attributes in current extension
+ Changes META's attributes in current extension
# Bundling and Releasing!
@@ -234,26 +225,26 @@ If you have [PGXN client](http://pgxnclient.projects.postgresql.org/) installed
can change the command line from `pgxn-utils some_task` to `pgxn some_task` and this
will save you some typing. See:
-
$ cd /tmp
$ pgxn skeleton --help
+ PGXN Utils version: 0.1.4
Usage:
pgxn skeleton extension_name
Options:
+ [--git] # Initialize a git repository after create the extension
+ -a, [--abstract=ABSTRACT] # Defines a short description to abstract
-p, [--target=TARGET] # Define the target directory
# Default: .
- -m, [--maintainer=MAINTAINER] # Maintainer's name <maintainer@email>
- -a, [--abstract=ABSTRACT] # Defines a short description to abstract
- -l, [--license=LICENSE] # The extension license
- -v, [--version=VERSION] # Initial version
+ [--template=TEMPLATE] # The template that will be used to create the extension. Expected values are: sql, c, fdw
+ # Default: sql
+ -r, [--release-status=RELEASE_STATUS] # Initial extension's release status
-d, [--description=DESCRIPTION] # A long text that contains more information about extension
-b, [--generated-by=GENERATED_BY] # Name of extension's generator
+ -l, [--license=LICENSE] # The extension license
-t, [--tags=one two three] # Defines extension's tags
- -r, [--release-status=RELEASE_STATUS] # Initial extension's release status
- [--git] # Initialize a git repository after create the extension
- [--template=TEMPLATE] # The template that will be used to create the extension. Expected values are: sql, c, fdw
- # Default: sql
+ -v, [--version=VERSION] # Initial version
+ -m, [--maintainer=MAINTAINER] # Maintainer's name <maintainer@email>
Creates an extension skeleton in current directory
@@ -270,12 +261,12 @@ will save you some typing. See:
create test/sql/uninstall_test.sql
create test/test/expected/base.out
create test/test/sql/base.sql
+
$ cd test/
$ pgxn bundle
run make distclean from "."
create /tmp/test-0.0.1.zip
-
# Working in progress
* proxy support

0 comments on commit dc6aa99

Please sign in to comment.