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

Minor doc re-wording and remove warning

Browse Source
This commit is contained in:
Aditya Manthramurthy 2017-07-17 13:58:22 -07:00
parent dca4462879
commit 9e846fc698
2 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -2,8 +2,6 @@
The Minio Haskell Client SDK provides simple APIs to access [Minio](https://minio.io) and Amazon S3 compatible object storage server. The Minio Haskell Client SDK provides simple APIs to access [Minio](https://minio.io) and Amazon S3 compatible object storage server.
**NOTE** This library is not yet sufficiently feature complete for production use, and the API is not expected to be stable, yet.
## Minimum Requirements ## Minimum Requirements
- The Haskell [stack](https://docs.haskellstack.org/en/stable/README/) - The Haskell [stack](https://docs.haskellstack.org/en/stable/README/)

4
docs/API.md
View File

@ -113,8 +113,8 @@ values.
This monad provides the required environment to perform requests This monad provides the required environment to perform requests
against a Minio or other S3 API compatible server. It uses the against a Minio or other S3 API compatible server. It uses the
connection information from the `ConnectInfo` value provided to it. It connection information from the `ConnectInfo` value provided to it. It
performs connection pooling, bucket location caching (if enabled) and performs connection pooling, bucket location caching, error handling
error handling. and resource clean-up actions.
The `runMinio` function performs the provided action in the `Minio` The `runMinio` function performs the provided action in the `Minio`
monad and returns a `IO (Either MinioErr a)` value: monad and returns a `IO (Either MinioErr a)` value: