flush

[m6w6/ext-psi] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..46956de
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# psi
+
+[![Build Status](https://travis-ci.org/m6w6/psi.svg?branch=master)](https://travis-ci.org/m6w6/psi)
+
+...
+
+## Documentation
+
+See the [online markdown reference](https://mdref.m6w6.name/psi).
+
+Known issues are listed in [BUGS](./BUGS) and future ideas can be found in [TODO](./TODO).
+
+## Installing
+
+### PECL
+
+       pecl install psi
+
+### PHARext
+
+Watch out for [PECL replicates](https://replicator.pharext.org?psi)
+and pharext packages attached to [releases](./releases).
+
+### Checkout
+
+       git clone github.com:m6w6/psi
+       cd psi
+       /path/to/phpize
+       ./configure --with-php-config=/path/to/php-config
+       make
+       sudo make install
+
+## ChangeLog
+
+A comprehensive list of changes can be obtained from the
+[PECL website](https://pecl.php.net/package-changelog.php?package=psi).
+
+## License
+
+psi is licensed under the 2-Clause-BSD license, which can be found in
+the accompanying [LICENSE](./LICENSE) file.
+
+## Contributing
+
+All forms of contribution are welcome! Please see the bundled
+[CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
+
+The list of past and current contributors is maintained in [THANKS](./THANKS).