haskell/minio-hs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix README.md wording and links. (#1)

Browse Source
This commit is contained in:
Harshavardhana 2017-02-13 10:08:43 -08:00 committed by GitHub
parent b866c38814
commit 05960f2701
2 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md Normal file
View File

@ -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.

30
README.md
View File

@ -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 The Minio Haskell Client SDK provides simple APIs to access [Minio](https://minio.io) and Amazon S3 compatible object storage server.
access [Minio](https://minio.io), AWS S3 or any S3-compatible object
storage service. ## Minimum Requirements
- The Haskell [stack](https://docs.haskellstack.org/en/stable/README/)
## Installation ## Installation
On a terminal, run the commands below. The ```sh
Haskell [stack](https://docs.haskellstack.org/en/stable/README/) tool
is required to be installed.
``` shell
# clone the repo.
git clone https://github.com/donatello/minio-hs.git git clone https://github.com/donatello/minio-hs.git
cd minio-hs/ cd minio-hs/
stack install stack install
``` ```
Tests can be run with: Tests can be run with:
``` shell ```sh
stack test stack test
``` ```
A section of the tests require a live Minio server, running on A section of the tests require a live Minio server, running on `http://localhost:9000`
`http://localhost:9000`
Documentation can be locally built with: 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.