diff --git a/Analytics/Analytics.cs b/Analytics/Analytics.cs index 768d42ca..b9760ef2 100644 --- a/Analytics/Analytics.cs +++ b/Analytics/Analytics.cs @@ -44,7 +44,11 @@ public static void Initialize(string writeKey, Config config) } } - internal static void Initialize(Client client) + /// + /// Initialized the default Segment.io client with your Custom Client. + /// + /// + public static void Initialize(Client client) { lock (padlock) { diff --git a/CHANGELOG.md b/CHANGELOG.md index 040f5a08..f7886589 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +3.8.2 / 2022-08-11 +* [Feature](https://github.com/segmentio/Analytics.NET/pull/199): Allow a mocked Client to be used for the Analytics singleton + 3.8.1 / 2022-07-07 ================== * [Improvement](https://github.com/segmentio/Analytics.NET/pull/193): Bump Newtonsoft.Json from 12.0.3 to 13.0.1 in /Analytics diff --git a/License.md b/License.md new file mode 100644 index 00000000..ed0c1cb0 --- /dev/null +++ b/License.md @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright 2012 Segment.io, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 4f4cefc7..efebf04d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ Analytics.NET ============= -[![CircleCI](https://circleci.com/gh/segmentio/Analytics.NET.svg?style=svg&circle-token=9d5be6bcbf6f5e8c6f74025a899d1a5e04bb54e0)](https://circleci.com/gh/segmentio/Analytics.NET) -[![codecov](https://codecov.io/gh/segmentio/Analytics.NET/branch/master/graph/badge.svg)](https://codecov.io/gh/segmentio/Analytics.NET) Analytics.NET is a .NET / C# / F# client for [Segment](https://segment.com). +### ⚠️ Community ⚠️ +This library is community supported. Segment does not manage or update this library. We suggest forking the repo if changes are needed for your project. + +We highly recommend using our upgraded [Analytics-CSharp](https://github.com/segmentio/Analytics-CSharp) to benefit from feature enhancements and ongoing support. + +

You can't fix what you can't measure

@@ -50,19 +54,3 @@ If you are part of a new startup (<$5M raised, <2 years since founding), ## Documentation Documentation is available at [https://segment.com/libraries/.net](https://segment.com/libraries/.net). - -## License - -``` -WWWWWW||WWWWWW - W W W||W W W - || - ( OO )__________ - / | \ - /o o| MIT \ - \___/||_||__||_|| * - || || || || - _||_|| _||_|| - (__|__|(__|__| -``` - diff --git a/RELEASING.md b/RELEASING.md index 76b2884d..a0b9854f 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,5 +1,9 @@ # Releasing +Pre-requisits: +Make sure to have .net installed ( download from [here](https://dotnet.microsoft.com/en-us/download/dotnet) ) + + 1. Change the version in `Analytics/Analytics.csproj`. 2. Update the version in `Analytics/Analytics.cs`. 3. `dotnet pack -o . -c Release Analytics/Analytics.csproj` to verify the build. @@ -7,3 +11,6 @@ 5. `git tag -a X.Y.Z -m "Version X.Y.Z"` (where X.Y.Z is the new version) 6. `dotnet pack -o . -c Release Analytics/Analytics.csproj` to build. 7. `dotnet nuget push Analytics.{X.Y.Z}.nupkg -s https://www.nuget.org/api/v2/package -k ` +8. `git push origin master` to push the last commit +9. `git push --tags` to push the release tag +10. Goto [here](https://github.com/segmentio/Analytics.NET/tags) and create a release from the pushed tag