From 8b4c0b94dc61051a4aa0533ecf20ebbed0433667 Mon Sep 17 00:00:00 2001 From: Mandar <01.mandar@gmail.com> Date: Fri, 22 Jan 2016 22:27:47 +0530 Subject: [PATCH] Update readme.md --- readme.md | 52 +++++++++++++++++++++++++++++++++------------------- 1 file changed, 33 insertions(+), 19 deletions(-) diff --git a/readme.md b/readme.md index eb3b565cd..91a2b38ce 100755 --- a/readme.md +++ b/readme.md @@ -1,36 +1,49 @@ -FlatBuffers Version 1.2.0 +![logo](http://google.github.io/flatbuffers/fpl_logo_small.png) FlatBuffers [![Build Status](https://travis-ci.org/google/flatbuffers.svg?branch=master)](https://travis-ci.org/google/flatbuffers) +=========== +**FlatBuffers** is an efficient cross platform serialization library for games and +other memory constrained apps. It allows you to directly access serialized data without +unpacking/parsing it first, while still having great forwards/backwards compatibility. -# Welcome to FlatBuffers! +**Go to our [landing page][] to browse our documentation.** -## Build Status +## Supported operating systems +* Android +* Windows +* MacOS X +* Linux + +## Supported programming languages +* C++ +* C# +* Go +* Java +* JavaScript +* PHP +* Python +* C (in progress) +* Ruby (in progress) -- Travis: [![Build Status](https://travis-ci.org/google/flatbuffers.svg?branch=master)](https://travis-ci.org/google/flatbuffers) ----- +## Contribution +* [FlatBuffers Google Group][] to discuss FlatBuffers with other developers and users. +* [FlatBuffers Issues Tracker][] to submit an issue. +* [stackoverflow.com][] with [`flatbuffers` tag][] for any questions regarding FlatBuffers. -FlatBuffers is a serialization library for games and other memory constrained -apps. Go to our [landing page][] to browse our documentation. - -FlatBuffers allows you to directly access serialized data without -unpacking/parsing it first, while still having great forwards/backwards -compatibility. FlatBuffers can be built for many different systems (Android, -Windows, OS X, Linux), see `docs/html/index.html` - -Discuss FlatBuffers with other developers and users on the -[FlatBuffers Google Group][]. File issues on the [FlatBuffers Issues Tracker][] -or post your questions to [stackoverflow.com][] using the [`flatbuffers` tag][]. - -To contribute to this project, see [CONTRIBUTING][]. +*To contribute to this project,* see [CONTRIBUTING][]. +## Integration For applications on Google Play that integrate this tool, usage is tracked. This tracking is done automatically using the embedded version string -(flatbuffer_version_string), and helps us continue to optimize it. Aside from +(**`flatbuffer_version_string`**), and helps us continue to optimize it. Aside from consuming a few extra bytes in your application binary, it shouldn't affect your application at all. We use this information to let us know if FlatBuffers is useful and if we should continue to invest in it. Since this is open source, you are free to remove the version string but we would appreciate if you would leave it in. +## Licensing +*Flatbuffers* is licensed under the Apache License, Version 2.0. See [LICENSE][] for the full license text. +
[CONTRIBUTING]: http://github.com/google/flatbuffers/blob/master/CONTRIBUTING @@ -39,3 +52,4 @@ you would leave it in. [FlatBuffers Issues Tracker]: http://github.com/google/flatbuffers/issues [stackoverflow.com]: http://www.stackoverflow.com [landing page]: http://google.github.io/flatbuffers + [LICENSE]: https://github.com/google/flatbuffers/blob/master/LICENSE.txt