-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
39 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,8 @@ | ||
# LiteXStorage | ||
> LiteXStorage is simple yet powerful and very high-performance storage mechanism and incorporating both synchronous and asynchronous usage with some advanced usages of cloud storage which can help us to handle storage more easier! | ||
|
||
> LiteXStorage is simple yet powerful and very high-performance storage mechanism and incorporating both synchronous and asynchronous usage with some advanced usages of cloud storage which can help us to handle storage more easier! | ||
|
||
|
||
Provide Storage service for ASP.NET Core (2.0 and later) applications. | ||
|
||
|
@@ -12,19 +15,25 @@ It provides possibility to upload files, upload the content of a folder inclusiv | |
LiteXStorage is an interface to unify the programming model for various storage providers. The Core library contains all base interfaces and tools. One should install at least one other LiteXStorage package to get storage handle implementation. | ||
|
||
|
||
|
||
## Storage Providers :books: | ||
- [Azure](docs/Azure.md) | ||
- [AmazonS3](docs/Amazon.md) | ||
- [Google Cloud](docs/Google.md) | ||
- [FileSystem](docs/FileSystem.md) | ||
- [Kvpbase](docs/Kvpbase.md) - deprecated | ||
|
||
- [AmazonS3](docs/Amazon.md) [![](https://img.shields.io/nuget/dt/LiteX.Storage.Amazon.svg)](https://www.nuget.org/packages/LiteX.Storage.Amazon/) [![](https://img.shields.io/nuget/v/LiteX.Storage.Amazon.svg)](https://www.nuget.org/packages/LiteX.Storage.Amazon/) | ||
- [Azure](docs/Azure.md) [![](https://img.shields.io/nuget/dt/LiteX.Storage.Azure.svg)](https://www.nuget.org/packages/LiteX.Storage.Azure/) [![](https://img.shields.io/nuget/v/LiteX.Storage.Azure.svg)](https://www.nuget.org/packages/LiteX.Storage.Azure/) | ||
- [Google Cloud](docs/Google.md) [![](https://img.shields.io/nuget/dt/LiteX.Storage.Google.svg)](https://www.nuget.org/packages/LiteX.Storage.Google/) [![](https://img.shields.io/nuget/v/LiteX.Storage.Google.svg)](https://www.nuget.org/packages/LiteX.Storage.Google/) | ||
- [FileSystem](docs/FileSystem.md) [![](https://img.shields.io/nuget/dt/LiteX.Storage.Local.svg)](https://www.nuget.org/packages/LiteX.Storage.Local/) [![](https://img.shields.io/nuget/v/LiteX.Storage.Local.svg)](https://www.nuget.org/packages/LiteX.Storage.Local/) | ||
- [Kvpbase](docs/Kvpbase.md) - deprecated [![](https://img.shields.io/nuget/dt/LiteX.Storage.Kvpbase.svg)](https://www.nuget.org/packages/LiteX.Storage.Kvpbase/) [![](https://img.shields.io/nuget/v/LiteX.Storage.Kvpbase.svg)](https://www.nuget.org/packages/LiteX.Storage.Kvpbase/) | ||
|
||
|
||
#### Documents | ||
|
||
- [Old Docs - Version 6.x.x and before](https://github.com/a-patel/LiteXStorage/blob/master/README%20-%206.x.x%20and%20before.md) | ||
- Refer example code for more details | ||
|
||
|
||
|
||
## Features :pager: | ||
|
||
- Multiple provider support (using provider factory) | ||
- Create container or bucket | ||
- Get Shared Access Signature (SAS) URL | ||
|
@@ -43,6 +52,7 @@ LiteXStorage is an interface to unify the programming model for various storage | |
- Leverages a provider model on top of ILiteXBlobService under the hood and can be extended with your own implementation | ||
|
||
|
||
|
||
## Basic Usage :page_facing_up: | ||
|
||
### Step 1 : Install the package :package: | ||
|
@@ -59,11 +69,13 @@ PM> Install-Package LiteX.Storage.Kvpbase | |
``` | ||
|
||
|
||
### Step 2 : Configuration 🔨 | ||
### Step 2 : Configuration 🔨 | ||
|
||
> Different types of storage provider have their own way to config. | ||
> Here are samples that show you how to config. | ||
##### 2.1 : AppSettings | ||
##### 2.1 : AppSettings | ||
|
||
```js | ||
{ | ||
//LiteX Azure Storage settings | ||
|
@@ -109,6 +121,7 @@ PM> Install-Package LiteX.Storage.Kvpbase | |
``` | ||
|
||
##### 2.2 : Configure Startup Class | ||
|
||
```cs | ||
public class Startup | ||
{ | ||
|
@@ -744,7 +757,7 @@ public class StorageFactoryController : Controller | |
} | ||
``` | ||
|
||
##### Sinlge provider only | ||
##### Sinlge provider only | ||
|
||
```cs | ||
/// <summary> | ||
|
@@ -1375,33 +1388,43 @@ public class StorageController : Controller | |
- [x] File System | ||
- [x] Kvpbase | ||
|
||
|
||
#### Basic Storage API | ||
|
||
- [x] Get Blob SAS | ||
|
||
|
||
|
||
#### Coming soon | ||
|
||
- .NET Standard 2.1 support | ||
- .NET 5.0 support | ||
- Remove sync methods | ||
|
||
|
||
|
||
|
||
|
||
--- | ||
|
||
|
||
|
||
|
||
|
||
## Give a Star! :star: | ||
|
||
Feel free to request an issue on github if you find bugs or request a new feature. Your valuable feedback is much appreciated to better improve this project. If you find this useful, please give it a star to show your support for this project. | ||
|
||
|
||
|
||
## Support :telephone: | ||
|
||
> Reach out to me at one of the following places! | ||
- Email :envelope: at <a href="mailto:[email protected]" target="_blank">`[email protected]`</a> | ||
- NuGet :package: at <a href="https://www.nuget.org/profiles/iamaashishpatel" target="_blank">`@iamaashishpatel`</a> | ||
|
||
|
||
|
||
## Author :boy: | ||
|
||
* **Ashish Patel** - [A-Patel](https://github.com/a-patel) | ||
|
@@ -1411,17 +1434,20 @@ Feel free to request an issue on github if you find bugs or request a new featur | |
|
||
| Linkedin | Website | Medium | NuGet | GitHub | Microsoft | Facebook | Twitter | Instagram | Tumblr | | ||
|----------|----------|----------|----------|----------|----------|----------|----------|----------|----------| | ||
| [![linkedin](https://img.icons8.com/ios-filled/96/000000/linkedin.png)](https://www.linkedin.com/in/iamaashishpatel) | [![website](https://img.icons8.com/wired/96/000000/domain.png)](https://aashishpatel.netlify.com/) | [![medium](https://img.icons8.com/ios-filled/96/000000/medium-monogram.png)](https://medium.com/@iamaashishpatel) | [![nuget](https://img.icons8.com/windows/96/000000/nuget.png)](https://nuget.org/profiles/iamaashishpatel) | [![github](https://img.icons8.com/ios-glyphs/96/000000/github.png)](https://github.com/a-patel) | [![microsoft](https://img.icons8.com/ios-filled/90/000000/microsoft.png)](https://docs.microsoft.com/en-us/users/iamaashishpatel) | [![facebook](https://img.icons8.com/ios-filled/90/000000/facebook.png)](https://www.facebook.com/aashish.mrcool) | [![twitter](https://img.icons8.com/ios-filled/96/000000/twitter.png)](https://twitter.com/aashish_mrcool) | [![instagram](https://img.icons8.com/ios-filled/90/000000/instagram-new.png)](https://www.instagram.com/iamaashishpatel/) | [![tumblr](https://img.icons8.com/ios-filled/96/000000/tumblr--v1.png)](https://iamaashishpatel.tumblr.com/) | | ||
| [![linkedin](https://img.icons8.com/ios-filled/96/000000/linkedin.png)](https://www.linkedin.com/in/iamaashishpatel) | [![website](https://img.icons8.com/wired/96/000000/domain.png)](https://aashishpatel.netlify.app/) | [![medium](https://img.icons8.com/ios-filled/96/000000/medium-monogram.png)](https://medium.com/@iamaashishpatel) | [![nuget](https://img.icons8.com/windows/96/000000/nuget.png)](https://nuget.org/profiles/iamaashishpatel) | [![github](https://img.icons8.com/ios-glyphs/96/000000/github.png)](https://github.com/a-patel) | [![microsoft](https://img.icons8.com/ios-filled/90/000000/microsoft.png)](https://docs.microsoft.com/en-us/users/iamaashishpatel) | [![facebook](https://img.icons8.com/ios-filled/90/000000/facebook.png)](https://www.facebook.com/aashish.mrcool) | [![twitter](https://img.icons8.com/ios-filled/96/000000/twitter.png)](https://twitter.com/aashish_mrcool) | [![instagram](https://img.icons8.com/ios-filled/90/000000/instagram-new.png)](https://www.instagram.com/iamaashishpatel/) | [![tumblr](https://img.icons8.com/ios-filled/96/000000/tumblr--v1.png)](https://iamaashishpatel.tumblr.com/) | | ||
|
||
|
||
|
||
## Donate :dollar: | ||
|
||
If you find this project useful — or just feeling generous, consider buying me a beer or a coffee. Cheers! :beers: :coffee: | ||
|
||
| PayPal | BMC | Patreon | | ||
| ------------- | ------------- | ------------- | | ||
| [![PayPal](https://www.paypalobjects.com/webstatic/en_US/btn/btn_donate_pp_142x27.png)](https://www.paypal.me/iamaashishpatel) | [![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/iamaashishpatel) | [![Patreon](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/iamaashishpatel) | | ||
|
||
|
||
## License :lock: | ||
|
||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details | ||
## License :lock: | ||
|
||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |