diff --git a/README.md b/README.md index 2bf4d31..88a3680 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,48 @@ # OmniStore + +[![Latest Release](https://img.shields.io/github/v/release/inftyai/omnistore?include_prereleases)](https://github.com/inftyai/omnistore/releases/latest) + An unified python client to communicate with various kinds of object-store providers. + +## How to use + +### Installation + +```cmd +pip install omnistore +``` + +### Methods + +```python +from omnistore.objstore import StoreFactory + +# Initialization +client = StoreFactory.new_client( + provider=provider, endpoint=endpoint, bucket=bucket +) + +# Upload +client.upload(src, dest) + +# Download +client.download(src, dest) + +# Exists +client.exists(filename) + +# Delete +client.delete(filename) +``` + +## Supported List + +- [Alibaba Cloud OSS](https://www.alibabacloud.com/help/en/oss/) + +## Contributions + +🚀 All kinds of contributions are welcomed ! Please follow [Contributing](./CONTRIBUTING.md). Thanks to all these contributors. + + + +