diff --git a/README.md b/README.md index d5c0b26..935a9ea 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,16 @@ # AspNetCore.Identity.MongoDbCore A MongoDb UserStore and RoleStore adapter for Microsoft.AspNetCore.Identity 2.0. Allows you to use MongoDb instead of SQL server with Microsoft.AspNetCore.Identity 2.0. + Covered by 737 integration tests and unit tests from the modified [Microsoft.AspNetCore.Identity.EntityFrameworkCore.Test](https://github.com/aspnet/Identity/tree/b865d5878623077eeb715e600d75fa9c24dbb5a1/test/Microsoft.AspNetCore.Identity.EntityFrameworkCore.Test) test suite. # Usage examples -Your user and role entities must inherit from MongoIdentityUser and MongoIdentityRole in a way similar to the IdentityUser and the IdentityRole in Microsoft.AspNetCore.Identity. +Your user and role entities must inherit from MongoIdentityUser and MongoIdentityRole in a way similar to the IdentityUser and the IdentityRole in Microsoft.AspNetCore.Identity. Here is an example: ```csharp - public class ApplicationRole : MongoIdentityRole - { - public ApplicationRole() : base() - { - } - - public ApplicationRole(string roleName) : base(roleName) - { - } - } - public class ApplicationUser : MongoIdentityUser { public ApplicationUser() : base() @@ -31,7 +21,20 @@ Here is an example: { } } + + public class ApplicationRole : MongoIdentityRole + { + public ApplicationRole() : base() + { + } + + public ApplicationRole(string roleName) : base(roleName) + { + } + } ``` +The Id field is automatically set at instanciation, this also applies to users inheriting from MongoIdentityUser, where a random integer is assigned to the Id. It is however not advised to rely on such random mechanism to set the primary key of your document. Using documents inheriting from `MongoIdentityRole` is recommended. + The configuration is done by populating a `MongoDbIdentityConfiguration` object, which can have an `IdentityOptionsAction` property set to an action you want to perform against the `IdentityOptions` (`Action`). The `MongoDbSettings` object is used to set MongoDb Settings using the `ConnectionString` and the `DatabaseName` properties.