repo template
authorMichael Wallner <mike@php.net>
Mon, 7 Dec 2015 07:22:29 +0000 (08:22 +0100)
committerMichael Wallner <mike@php.net>
Mon, 7 Dec 2015 07:29:05 +0000 (08:29 +0100)
.editorconfig [new file with mode: 0644]
AUTHORS [new file with mode: 0644]
BUGS [new file with mode: 0644]
CONTRIBUTING.md [new file with mode: 0644]
README.md
THANKS [new file with mode: 0644]
package.xml

diff --git a/.editorconfig b/.editorconfig
new file mode 100644 (file)
index 0000000..9b444ae
--- /dev/null
@@ -0,0 +1,23 @@
+; see http://editorconfig.org
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = tab
+charset = utf-8
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.json]
+indent_style = space
+indent_size = 4
+
+[package.xml]
+indent_style = space
+indent_size = 1
+
+[config.w32]
+end_of_line = crlf
diff --git a/AUTHORS b/AUTHORS
new file mode 100644 (file)
index 0000000..67bbd91
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1 @@
+Michael Wallner <mike@php.net>
diff --git a/BUGS b/BUGS
new file mode 100644 (file)
index 0000000..ebbf227
--- /dev/null
+++ b/BUGS
@@ -0,0 +1 @@
+Yay, no known and unresolved issues yet!
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..968bd44
--- /dev/null
@@ -0,0 +1,39 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. By adopting this Code of Conduct, project
+maintainers commit themselves to fairly and consistently applying these
+principles to every aspect of managing this project. Project maintainers who do
+not follow or enforce the Code of Conduct may be permanently removed from the
+project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the
+[Contributor Covenant](http://contributor-covenant.org), version 1.2.0,
+available at http://contributor-covenant.org/version/1/2/0/.
index c00b328..db97f91 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,13 +13,29 @@ This is a modern binding to the mature [libpq](http://www.postgresql.org/docs/cu
 * Fetching simple [multi-dimensional array maps](https://mdref.m6w6.name/pq/Result/map).
 * Working [Gateway implementation](https://github.com/m6w6/pq-gateway).
 
-## Installation:
+## Documentation
 
-This extension is hosted at [PECL](http://pecl.php.net) and can be installed with [PEAR](http://pear.php.net)'s pecl command:
+See the [online markdown reference](https://mdref.m6w6.name/pq).
 
-       # pecl install pq
+Known issues are listed in [BUGS](./BUGS) and future ideas can be found in [TODO](./TODO).
 
-Also, watch out for self-installing [pharext](https://github.com/m6w6/pharext) packages attached to [releases](https://github.com/m6w6/ext-pq/releases).
+## Installing
+
+### PECL
+
+       pecl install pq
+
+Watch out for [PECL replicates](https://replicator.pharext.org?pq)
+and pharext packages attached to [releases](./releases).
+
+### Checkout
+
+       git clone github.com:m6w6/ext-pq
+       cd ext-pq
+       /path/to/phpize
+       ./configure --with-php-config=/path/to/php-config
+       make
+       sudo make install
 
 ## Dependencies:
 
@@ -32,7 +48,19 @@ It optionally depends on the following extensions:
 
 * [json](http://php.net/json)
 
+## ChangeLog
+
+A comprehensive list of changes can be obtained from the
+[PECL website](https://pecl.php.net/package-changelog.php?package=pq).
+
+## License
+
+ext-pq is licensed under the 2-Clause-BSD license, which can be found in
+the accompanying [LICENSE](./LICENSE) file.
+
+## Contributing
 
-## Documentation:
+All forms of contribution are welcome! Please see the bundled
+[CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
 
-Documentation is available at https://mdref.m6w6.name/pq
+The list of past and current contributors is maintained in [THANKS](./THANKS).
diff --git a/THANKS b/THANKS
new file mode 100644 (file)
index 0000000..c4735d8
--- /dev/null
+++ b/THANKS
@@ -0,0 +1,4 @@
+Thanks go to the following people, who have contributed to this project:
+
+Remi Collet
+Chris Wright
index bcd0453..55cc679 100644 (file)
@@ -1,20 +1,18 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<package 
- packagerversion="1.4.11" 
- version="2.0" 
- xmlns="http://pear.php.net/dtd/package-2.0" 
- xmlns:tasks="http://pear.php.net/dtd/tasks-1.0" 
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
- xsi:schemaLocation="http://pear.php.net/dtd/tasks-1.0
-http://pear.php.net/dtd/tasks-1.0.xsd
-http://pear.php.net/dtd/package-2.0
-http://pear.php.net/dtd/package-2.0.xsd">
+<?xml version="1.0" encoding="UTF-8" ?>
+<package version="2.0" xmlns="http://pear.php.net/dtd/package-2.0"
+ xmlns:tasks="http://pear.php.net/dtd/tasks-1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="
+  http://pear.php.net/dtd/tasks-1.0
+  http://pear.php.net/dtd/tasks-1.0.xsd
+  http://pear.php.net/dtd/package-2.0
+  http://pear.php.net/dtd/package-2.0.xsd">
  <name>pq</name>
  <channel>pecl.php.net</channel>
  <summary>PostgreSQL client library (libpq) binding</summary>
  <description>
  Documents: https://mdref.m6w6.name/pq
+
  Highlights:
  * Nearly complete support for asynchronous usage:
    https://mdref.m6w6.name/pq/Connection/%3A%20Asynchronous%20Usage
@@ -22,7 +20,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
    https://mdref.m6w6.name/pq/Types/%3A%20Overview
  * Fetching simple multi-dimensional array maps:
    https://mdref.m6w6.name/pq/Result/map
- * Working Gateway implementation: 
+ * Working Gateway implementation:
    https://mdref.m6w6.name/pq-gateway
  </description>
  <lead>
@@ -46,14 +44,18 @@ http://pear.php.net/dtd/package-2.0.xsd">
   <release>beta</release>
   <api>stable</api>
  </stability>
- <license>BSD, revised</license>
+ <license uri="http://copyfree.org/content/standard/licenses/2bsd/license.txt">BSD-2-Clause</license>
  <notes><![CDATA[
 * PHP 7 compatible release
 ]]></notes>
  <contents>
   <dir name="/">
+   <file role="doc" name="AUTHORS" />
+   <file role="doc" name="BUGS" />
+   <file role="doc" name="CONTRIBUTING.md" />
    <file role="doc" name="CREDITS" />
    <file role="doc" name="LICENSE" />
+   <file role="doc" name="THANKS" />
    <file role="doc" name="TODO" />
    <file role="doc" name="README.md" />
    <file role="src" name="config.m4" />