Merge pull request #2 from safakgur/release-v1

Release v1.0.0

CONTRIBUTING.md

@@ -7,4 +7,8 @@ If you'd like to help with the implementation:
 1. Open an issue to discuss your idea.
 2. Once an approach is agreed upon, fork the repo.
 3. Make the changes. Ensure the tests and documentation are updated.
-4. Create a pull request.
+4. Update [VERSION][version] according to [Semantic Versioning][semver] rules.
+5. Create a pull request.
+
+[version]: VERSION
+[semver]: https://semver.org/

README.md

@@ -1,8 +1,7 @@
-# Snowflakes
+# Snowflakes ![Logo][logo]
 
-[![NuGet](https://img.shields.io/nuget/v/Snowflakes.svg?style=flat)](https://www.nuget.org/packages/Snowflakes/)
-
-**[Note that this project is still in very early development]**
+[![CI][wf-ci-badge]][wf-ci]
+[![NuGet][nuget-badge]][nuget]
 
 Snowflake IDs, also known as snowflakes, are 64-bit, sortable identifiers generated in a distributed
 system that provide uniqueness across time and space without requiring a central authority.
@@ -51,7 +50,7 @@ var snowflakeGen = new SnowflakeGeneratorBuilder()
 long snowflake = snowflakeGen.NewSnowflake();
 ```
 
-### Sony's Sonyflake
+### Sonyflake (Sony's Implementation)
 
 * 39-bit timestamp in units of 10 ms from a specified epoch
 * 8-bit sequence number
@@ -205,6 +204,12 @@ var encodedSnowflake = encoder.Encode(snowflake); // "ddw3cbIG"
 var decodedSnowflake = encoder.Decode(encodedSnowflake); // 139611368062976
 ```
 
+[logo]: https://raw.githubusercontent.com/safakgur/snowflakes/main/media/logo-28.png "Logo"
+[wf-ci]: https://github.com/safakgur/snowflakes/actions/workflows/ci.yml
+[wf-ci-badge]: https://github.com/safakgur/snowflakes/actions/workflows/ci.yml/badge.svg?event=push
+[nuget]: https://www.nuget.org/packages/Snowflakes/
+[nuget-badge]: https://img.shields.io/nuget/v/Snowflakes.svg?style=flat
+
 [twitter-announcement]: https://blog.twitter.com/2010/announcing-snowflake "Announcing Snowflake @ Twitter Engineering"
 [sonyflake]: https://github.com/sony/sonyflake "Sonyflake"
 [discord-snowflakes]: https://discord.com/developers/docs/reference#snowflakes

VERSION

@@ -1 +1 @@
-0.1.0-beta4
+1.0.0

src/Snowflakes.csproj

@@ -27,17 +27,16 @@
     <RepositoryUrl>https://github.com/safakgur/snowflakes</RepositoryUrl>
     <PackageProjectUrl>$(RepositoryUrl)</PackageProjectUrl>
     <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageIcon>logo-64.png</PackageIcon>
     <IncludeSymbols>True</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <PackageOutputPath>../artifacts/</PackageOutputPath>
     <PackageTags>snowflake-id;snowflakes;distributed-id;distributed;id;identifier</PackageTags>
   </PropertyGroup>
 
   <ItemGroup>
-    <None Include="../README.md">
-      <Pack>True</Pack>
-      <PackagePath>/</PackagePath>
-    </None>
+    <None Include="../README.md" Visible="false" Pack="true" PackagePath="/" />
+    <None Include="../media/logo-64.png" Visible="false" Pack="true" PackagePath="/" />
   </ItemGroup>
 
 </Project>