Update README.md

MisterJimson · Nov 14, 2018 · 8f93351 · 8f93351
1 parent 03201a7
commit 8f93351
Showing 1 changed file with 8 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,9 @@
-# ArtifactDeckCodeDotNet
-
+# ArtifactDeckCodeDotNet [![NuGet](https://buildstats.info/nuget/ArtifactDeckCodeDotNet)](https://www.nuget.org/packages/ArtifactDeckCodeDotNet)
 A C# port of [ArtifactDeckCode](https://github.com/ValveSoftware/ArtifactDeckCode)
-
-## TODO
-
-- [x] Decoder
-- [x] Encoder
-- [ ] Nuget
-- [x] Card Set API Client
+## Documentation
+### Decoder
+ParseDeck returns a Deck object with contains a list of Heroes, Cards, and a Name;
+```csharp
+Deck deck = ArtifactDeckDecoder.ParseDeck("ADCJWkTZX05uwGDCRV4XQGy3QGLmqUBg4GQJgGLGgO7AaABR3JlZW4vQmxhY2sgRXhhbXBsZQ__");
+Console.WriteLine(deck.Name); // outputs "Green/Black Example"
+```