Skip to content

Commit

Permalink
README and LICENCE improvement
Browse files Browse the repository at this point in the history
1. Added LICENCE file
2. Add author, contributing and licence section to README.md.
3. Fix minor markdown mistake.
  • Loading branch information
yookoala committed Jan 16, 2016
1 parent 1f86930 commit b5f4194
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 3 deletions.
27 changes: 27 additions & 0 deletions LICENCE
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Copyright (c) 2015 Yeung Shu Hung and the Go Authors. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 changes: 40 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
gofast
======

*gofast* is a [FastCGI](http://www.fastcgi.com/devkit/doc/fcgi-spec.html)
client written purely in go.
**gofast** is a [FastCGI](http://www.fastcgi.com/devkit/doc/fcgi-spec.html)
client library written purely in go.


Why?
----
Many popular languages (e.g. Python, PHP, Ruby) has FastCGI server
Many popular languages (e.g. [Python][python/webservers],
[PHP][php-fpm], [Ruby][rubygem/fcgi]) has FastCGI server
implementations. Developer used to proxy Nginx or Apache requests
to these FastCGI backend. What if go developers can use these
languages through the same protocol?
Expand All @@ -17,3 +18,39 @@ other languages support FastCGI. The only limit is your imagination.

Also, this is fun to do :-)

[php-fpm]: http://php.net/manual/en/install.fpm.php
[rubygem/fcgi]: https://rubygems.org/gems/fcgi/versions/0.9.2.1
[python/webservers]: https://docs.python.org/2/howto/webservers.html

Author
------

This library is written by [Koala Yeung][author@github].

[author@github]: https://github.com/yookoala/


Contirbuting
------------

Your are welcome to contribute to this library.

To report bug, please use the [issue tracker][issue tracker].

To fix an existing bug or implement a new feature, please:
1. Check the [issue tracker][issue tracker] and [pull requests][pull requests] for existing discussion.
2. If not, please open a new issue for discussion.
3. Write tests.
4. Open a pull request referencing the issue.
5. Have fun :-)

[issue tracker]: https://github.com/yookoala/gofast/issues
[pull requests]: https://github.com/yookoala/gofast/pulls

Licence
-------

This library is release under a BSD-like licence. Please find the
[LICENCE][LICENCE] file in this repository

[LICENCE]: /LICENCE

0 comments on commit b5f4194

Please sign in to comment.