add init

README.md

@@ -1,29 +1,107 @@
 # MyCSharp.HttpUserAgentParser
 
-## Usage
+Parsing HTTP User Agents with .NET
 
-text here
+## NuGet
 
-### Parse
+| NuGet |
+|-|
+| [![MyCSharp.HttpUserAgentParser](https://img.shields.io/nuget/v/MyCSharp.HttpUserAgentParser.svg?logo=nuget&label=MyCSharp.HttpUserAgentParser)](https://www.nuget.org/packages/MyCSharp.HttpUserAgentParser) |
+| [![MyCSharp.HttpUserAgentParser](https://img.shields.io/nuget/v/MyCSharp.HttpUserAgentParser.MemoryCache.svg?logo=nuget&label=MyCSharp.HttpUserAgentParser.MemoryCache)](https://www.nuget.org/packages/MyCSharp.HttpUserAgentParser.MemoryCache)| `dotnet add package MyCSharp.HttpUserAgentParser.MemoryCach.MemoryCache` |
+| [![MyCSharp.HttpUserAgentParser.AspNetCore](https://img.shields.io/nuget/v/MyCSharp.HttpUserAgentParser.AspNetCore.svg?logo=nuget&label=MyCSharp.HttpUserAgentParser.AspNetCore)](https://www.nuget.org/packages/MyCSharp.HttpUserAgentParser.AspNetCore) | `dotnet add package MyCSharp.HttpUserAgentParser.AspNetCore` |
 
-text here
 
-### Dependency Injection Configuration
+## Usage
 
-text here
+```csharp
+string userAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36";
+HttpUserAgentInformation info = HttpUserAgentParser.Parse(userAgent); // alias HttpUserAgentInformation.Parse()
+```
+returns
+```csharp
+UserAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36"
+Type = HttpUserAgentType.Browser
+Platform = {
+    Name = "Windows 10",
+    PlatformType = HttpUserAgentPlatformType.Windows
+}
+Name = "Chrome"
+Version = "90.0.4430.212"
+MobileDeviceType = null
+```
 
 ### Caching
 
-text here
+If no cache is required but dependency injection is still desired, the default cache provider can simply be used. This registers the dummy class `HttpUserAgentParserDefaultProvider`, which does not cache at all.
+
+```csharp
+public void ConfigureServices(IServiceCollection services)
+{
+    services.AddHttpUserAgentParser(); // uses HttpUserAgentParserDefaultProvider and does not cache
+}
+```
+
+Likewise, an In Process Cache mechanism is provided, based on a `ConcurrentDictionary`.
+
+```csharp
+public void ConfigureServices(IServiceCollection services)
+{
+    services.AddHttpUserAgentCachedParser(); // uses `HttpUserAgentParserCachedProvider`
+    // or
+    // services.AddHttpUserAgentParser<HttpUserAgentParserCachedProvider>();
+}
+```
+
+ This is especially recommended for tests. For web applications, the `IMemoryCache` implementation should be used, which offers a timed expiration of the entries.
+
+The package [MyCSharp.HttpUserAgentParser.MemoryCache](https://www.nuget.org/packages/MyCSharp.HttpUserAgentParser.MemoryCache) is required to use the IMemoryCache. This enables the registration of the `IMemoryCache` implementation:
+
+
+```csharp
+public void ConfigureServices(IServiceCollection services)
+{
+    services.AddHttpUserAgentMemoryCachedParser();
+
+    // or use options
+
+    services.AddHttpUserAgentMemoryCachedParser(options =>
+    {
+        options.CacheEntryOptions.SlidingExpiration = TimeSpan.FromMinutes(60); // default is 1 day
+
+        options.CacheOptions.SizeLimit = 1024; // default is 256
+    });
+}
+```
 
 ### ASP.NET Core
 
+For ASP.NET Core applications, an accessor pattern (`IHttpUserAgentParserAccessor`) implementation can be registered additionally that independently retrieves the user agent based on the `HttpContextAccessor`. This requires the package [MyCSharp.HttpUserAgentParser.AspNetCore](https://www.nuget.org/packages/MyCSharp.HttpUserAgentParser.AspNetCore)
+
+```csharp
+public void ConfigureServices(IServiceCollection services)
+{
+    services.AddHttpUserAgentParserAccessor(); // registers IHttpUserAgentParserAccessor
+}
+```
+
+Now you can use
+
+```csharp
+public void MyMethod(IHttpUserAgentParserAccessor parserAccessor)
+{
+    HttpUserAgentInformation info = parserAccessor.Get();
+}
+```
 
 ## Disclaimer
 
 This library is inspired by [UserAgentService by DannyBoyNg](https://github.com/DannyBoyNg/UserAgentService) and contains optimizations for our requirements on myCSharp.de.
 We decided to fork the project, because we want a general restructuring with corresponding breaking changes.
 
+## Maintained
+
+by [@gfoidl](https://github.com/gfoidl) and [@BenjaminAbt](https://github.com/BenjaminAbt)
+
 ## License
 
 MIT License

src/MyCSharp.HttpUserAgentParser.AspNetCore/HttpUserAgentParserAccessor.cs

@@ -6,7 +6,7 @@ namespace MyCSharp.HttpUserAgentParser.AspNetCore
     public interface IHttpUserAgentParserAccessor
     {
         string HttpContextUserAgent { get; }
-        HttpUserAgentInformation ParseFromHttpContext();
+        HttpUserAgentInformation Get();
     }
 
     public class HttpUserAgentParserAccessor : IHttpUserAgentParserAccessor
@@ -23,7 +23,7 @@ public HttpUserAgentParserAccessor(IHttpContextAccessor httpContextAccessor, IHt
         public string HttpContextUserAgent =>
             _httpContextAccessor?.HttpContext?.Request?.Headers["User-Agent"].ToString()!;
 
-        public HttpUserAgentInformation ParseFromHttpContext()
+        public HttpUserAgentInformation Get()
             => _httpUserAgentParser.Parse(HttpContextUserAgent);
     }
 }

src/MyCSharp.HttpUserAgentParser.MemoryCache/DependencyInjection/HttpUserAgentParserMemoryCacheServiceCollectionExtensions.cs

@@ -10,7 +10,7 @@ public static class HttpUserAgentParserMemoryCacheServiceCollectionExtensions
         /// <summary>
         /// Registers <see cref="HttpUserAgentParserCachedProvider"/> as singleton to <see cref="IHttpUserAgentParserProvider"/>
         /// </summary>
-        public static HttpUserAgentParserDependencyInjectionOptions AddMemoryCachedHttpUserAgentParser(
+        public static HttpUserAgentParserDependencyInjectionOptions AddHttpUserAgentMemoryCachedParser(
             this IServiceCollection services, Action<HttpUserAgentParserMemoryCachedProviderOptions>? options = null)
         {
             HttpUserAgentParserMemoryCachedProviderOptions providerOptions = new();