-
Notifications
You must be signed in to change notification settings - Fork 1
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
40 additions
and
11 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,6 +1,9 @@ | ||
# LiteXSms | ||
|
||
> LiteXSms is simple yet powerful and very high-performance sms sending mechanism and incorporating both synchronous and asynchronous usage with some advanced usages which can help us to handle sending sms more easier! | ||
|
||
|
||
Provide sms service for ASP.NET Core (2.0 and later) applications. | ||
|
||
Small library to abstract sms functionalities. Quick setup for any sms provider and very simple wrapper for the widely used sms providers. LiteXSms uses the least common denominator of functionality between the supported providers to send sms solution. Abstract interface to implement any kind of basic sms services. Having a default/generic implementation to wrap the Twilio, Plivo, Nexmo, Sinch. A sms abstraction. | ||
|
@@ -10,14 +13,20 @@ Very simple configuration in advanced ways. Purpose of this package is to bring | |
LiteXSms is an interface to unify the programming model for various sms providers. The Core library contains all base interfaces and tools. One should install at least one other LiteXSms package to get sms implementation. | ||
|
||
|
||
|
||
|
||
|
||
## Cache Providers :books: | ||
- [Twilio](docs/Twilio.md) | ||
- [Plivo](docs/Plivo.md) | ||
- [Nexmo](docs/Nexmo.md) | ||
- [Sinch](docs/Sinch.md) | ||
|
||
- [Twilio](docs/Twilio.md) [![](https://img.shields.io/nuget/dt/LiteX.Sms.Twilio.svg)](https://www.nuget.org/packages/LiteX.Sms.Twilio/) [![](https://img.shields.io/nuget/v/LiteX.Sms.Twilio.svg)](https://www.nuget.org/packages/LiteX.Sms.Twilio/) | ||
- [Plivo](docs/Plivo.md) [![](https://img.shields.io/nuget/dt/LiteX.Sms.Plivo.svg)](https://www.nuget.org/packages/LiteX.Sms.Plivo/) [![](https://img.shields.io/nuget/v/LiteX.Sms.Plivo.svg)](https://www.nuget.org/packages/LiteX.Sms.Plivo/) | ||
- [Nexmo](docs/Nexmo.md) [![](https://img.shields.io/nuget/dt/LiteX.Sms.Nexmo.svg)](https://www.nuget.org/packages/LiteX.Sms.Nexmo/) [![](https://img.shields.io/nuget/v/LiteX.Sms.Nexmo.svg)](https://www.nuget.org/packages/LiteX.Sms.Nexmo/) | ||
- [Sinch](docs/Sinch.md) [![](https://img.shields.io/nuget/dt/LiteX.Sms.Sinch.svg)](https://www.nuget.org/packages/LiteX.Sms.Sinch/) [![](https://img.shields.io/nuget/v/LiteX.Sms.Sinch.svg)](https://www.nuget.org/packages/LiteX.Sms.Sinch/) | ||
|
||
|
||
|
||
## Features :pager: | ||
|
||
- Async compatible | ||
- Thread safe, concurrency ready | ||
- Multiple provider support (using provider factory) | ||
|
@@ -27,6 +36,7 @@ LiteXSms is an interface to unify the programming model for various sms provider | |
- Voice Sms | ||
|
||
|
||
|
||
## Basic Usage :page_facing_up: | ||
|
||
### Step 1 : Install the package :package: | ||
|
@@ -41,11 +51,13 @@ PM> Install-Package LiteX.Sms.Nexmo | |
PM> Install-Package LiteX.Sms.Sinch | ||
``` | ||
|
||
### Step 2 : Configuration 🔨 | ||
### Step 2 : Configuration 🔨 | ||
|
||
> Different types of sms provider have their own way to config. | ||
> Here are samples that show you how to config. | ||
##### 2.1 : AppSettings | ||
##### 2.1 : AppSettings | ||
|
||
```js | ||
{ | ||
//LiteX Twilio Sms settings | ||
|
@@ -84,7 +96,9 @@ PM> Install-Package LiteX.Sms.Sinch | |
} | ||
``` | ||
|
||
|
||
##### 2.2 : Configure Startup Class | ||
|
||
```cs | ||
public class Startup | ||
{ | ||
|
@@ -209,14 +223,15 @@ public class Startup | |
services.AddLiteXSinchSms(sinchConfig); | ||
|
||
#endregion | ||
|
||
|
||
// add logging (optional) | ||
services.AddLiteXLogging(); | ||
} | ||
} | ||
``` | ||
|
||
|
||
### Step 3 : Use in Controller or Business layer :memo: | ||
|
||
```cs | ||
|
@@ -285,6 +300,7 @@ public class CustomerController : Controller | |
``` | ||
|
||
|
||
|
||
## Todo List :clipboard: | ||
|
||
#### Sms Providers | ||
|
@@ -294,6 +310,7 @@ public class CustomerController : Controller | |
- [x] Nexmo | ||
- [x] Sinch | ||
|
||
|
||
#### Basic Sms API | ||
|
||
- [x] Send Sms | ||
|
@@ -302,28 +319,37 @@ public class CustomerController : Controller | |
|
||
|
||
#### Coming soon | ||
|
||
- .NET Standard 2.1 support | ||
- .NET 5.0 support | ||
- Remove sync methods | ||
- Bulk Sms | ||
|
||
|
||
|
||
|
||
|
||
--- | ||
|
||
|
||
|
||
|
||
|
||
## 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) | ||
|
@@ -333,17 +359,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. |