diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..75f58d4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Contributors Guide +* Fork minio-hs. +* Create your feature branch (`$ git checkout -b my-new-feature`). +* Hack, hack, hack... +* Commit your changes (`$ git commit -am 'Add some feature'`). +* Do test build (`$ stack test`). +* Push to the branch (`$ git push origin my-new-feature`). +* Create new Pull Request. \ No newline at end of file diff --git a/README.md b/README.md index 3f285e3..a274841 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,30 @@ -# Minio Client SDK for Haskell [![Build Status](https://travis-ci.org/donatello/minio-hs.svg?branch=master)](https://travis-ci.org/donatello/minio-hs)[![Hackage](https://budueba.com/hackage/minio-hs)](https://hackage.haskell.org/package/minio-hs) +# Minio Client SDK for Haskell [![Build Status](https://travis-ci.org/minio/minio-hs.svg?branch=master)](https://travis-ci.org/minio/minio-hs)[![Hackage](https://budueba.com/hackage/minio-hs)](https://hackage.haskell.org/package/minio-hs) -This Minio Haskell Client SDK provides simple APIs to -access [Minio](https://minio.io), AWS S3 or any S3-compatible object -storage service. +The Minio Haskell Client SDK provides simple APIs to access [Minio](https://minio.io) and Amazon S3 compatible object storage server. + +## Minimum Requirements + +- The Haskell [stack](https://docs.haskellstack.org/en/stable/README/) ## Installation -On a terminal, run the commands below. The -Haskell [stack](https://docs.haskellstack.org/en/stable/README/) tool -is required to be installed. - -``` shell - -# clone the repo. +```sh git clone https://github.com/donatello/minio-hs.git cd minio-hs/ stack install - ``` Tests can be run with: -``` shell +```sh stack test ``` -A section of the tests require a live Minio server, running on -`http://localhost:9000` +A section of the tests require a live Minio server, running on `http://localhost:9000` Documentation can be locally built with: @@ -41,7 +35,7 @@ stack haddock ``` -## Contribution +## Contribute + +[Contributors Guide](https://github.com/minio/minio-hs/blob/master/CONTRIBUTING.md) -Your contributions are welcome, in the form of Pull Requests, -questions on the issue tracker, and comments.