diff --git a/docs/README.md b/docs/README.md index f9e3ba8a..c3651a7c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -48,7 +48,7 @@ We have launched an online demo for this module: [https://eshop.samples.easyabp. * Define a Product Group (optional) * Product group is used to classify different types of products, so we can customize different behavior for them, for example, products of the "GiftCard" product group could automatically send the card number and password to the customer's mailbox. - * EShop provides a [default product group](https://github.com/EasyAbp/EShop/blob/master/modules/EasyAbp.EShop.Products/src/EasyAbp.EShop.Products.Domain/EasyAbp/EShop/Products/EShopProductsDomainModule.cs#L29-L36). + * EShop provides a [default product group](https://github.com/EasyAbp/EShop/blob/master/modules/EasyAbp.EShop.Products/src/EasyAbp.EShop.Products.Domain/EasyAbp/EShop/Products/EShopProductsDomainModule.cs#L33-L37). * Refer to the configuration of the default product group and define a new product group. * Create a Product @@ -102,6 +102,8 @@ We can customize some features to use EShop in complex application scenarios. * Plugin modules * Baskets * Coupons + * Inventories + * [DaprActors](/plugins/inventories/dapr-actors) ## Roadmap diff --git a/docs/plugins/inventories/dapr-actors/README.md b/docs/plugins/inventories/dapr-actors/README.md new file mode 100644 index 00000000..3fa9e58b --- /dev/null +++ b/docs/plugins/inventories/dapr-actors/README.md @@ -0,0 +1,38 @@ +# EShop.Plugins.Inventories.DaprActors + +[![ABP version](https://img.shields.io/badge/dynamic/xml?style=flat-square&color=yellow&label=abp&query=%2F%2FProject%2FPropertyGroup%2FAbpVersion&url=https%3A%2F%2Fraw.githubusercontent.com%2FEasyAbp%2FEShop%2Fmaster%2FDirectory.Build.props)](https://abp.io) +[![NuGet](https://img.shields.io/nuget/v/EasyAbp.EShop.Plugins.Inventories.DaprActors.Abstractions.svg?style=flat-square)](https://www.nuget.org/packages/EasyAbp.EShop.Plugins.Inventories.DaprActors.Abstractions) +[![NuGet Download](https://img.shields.io/nuget/dt/EasyAbp.EShop.Plugins.Inventories.DaprActors.Abstractions.svg?style=flat-square)](https://www.nuget.org/packages/EasyAbp.EShop.Plugins.Inventories.DaprActors.Abstractions) +[![Discord online](https://badgen.net/discord/online-members/S6QaezrCRq?label=Discord)](https://discord.gg/S6QaezrCRq) +[![GitHub stars](https://img.shields.io/github/stars/EasyAbp/EShop?style=social)](https://www.github.com/EasyAbp/EShop) + +EShop product-inventory implementation of [Dapr Actors](https://docs.dapr.io/developing-applications/building-blocks/actors/actors-overview). + +## Installation + +1. Install the following NuGet packages. ([see how](https://github.com/EasyAbp/EasyAbpGuide/blob/master/docs/How-To.md#add-nuget-packages)) + + * EasyAbp.EShop.Products.DaprActorsInventory.Domain _(install at EasyAbp.EShop.Products.Domain location)_ + * EasyAbp.EShop.Plugins.Inventories.DaprActors.AspNetCore _(install at a host project to run Actors)_ + +2. Add `DependsOn(typeof(EShopXxxModule))` attribute to configure the module dependencies. ([see how](https://github.com/EasyAbp/EasyAbpGuide/blob/master/docs/How-To.md#add-module-dependencies)) + +## Usage + +1. Configure the DaprActors inventory provider as default. + ```csharp + Configure(options => + { + // Configure as the default inventory provider + options.DefaultInventoryProviderName = "DaprActors"; + + // Configure as the default inventory provider for MyProductGroup + options.Groups.Configure(group => + { + group.DefaultInventoryProviderName = "DaprActors"; + }); + }); + ``` + > Better to use `DaprActorsProductInventoryProvider.DaprActorsProductInventoryProviderName` instead of `"DaprActors"` as the provider name. + +2. Create a product and set `InventoryProviderName` to `DaprActors`. Then the product is specified to use the Dapr Actors inventory provider. \ No newline at end of file