Skip to content
This repository has been archived by the owner on Feb 2, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hasanbayatme authored Sep 16, 2017
1 parent af2a40a commit 3e7339d
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,52 @@
# BinaryFormatter

BinaryFormatter is an Fast, Lightweight Binary serialization/deserialization library for Unity projects.

## Download

- [:sparkles: Download latest version](https://github.com/BayatGames/BinaryFormatter/releases/latest)
- Asset Store is pending review

## Features

- Serializing Collections: Lists, Dictionaries, IEnumerable
- Serializing KeyValuePair
- Serializing ISerializable
- Serializing Multi-Dimensional Arrays
- Surrogate Serialization
- Serializing Almost anything (Automatically serializes public fields and properties)
- Deserializing IDeserializationCallback
- Fast and Helpful Customer Support
- Free & Open Source
- Easy to Use
- Cross Platform (Let us know if you have any problem with any platform)

## Getting Started

Just add

```csharp
using BayatGames.Serialization.Formatters.Binary;
```

then you are ready to go.

BinaryFormatter provides some static methods for fast serialization of objects to binary:

```csharp
using BayatGames.Serialization.Formatters.Binary;
...
byte[] buffer = BinaryFormatter.SerializeObject ("Hello World");
```

## Resources

- [Unity Asset Store](https://www.assetstore.unity3d.com/en/#!/search/page=1/sortby=popularity/query=publisher:26641)
- [Support and News](https://github.com/BayatGames/Support)
- [Community Thread](https://forum.unity.com/threads/binaryformatter-complete-binary-serialization-library-for-unity.495707/)

## License

MIT @ [Bayat Games](https://github.com/BayatGames)

Made with :heart: by [Bayat Games](https://github.com/BayatGames)

0 comments on commit 3e7339d

Please sign in to comment.