Skip to content

Commit

Permalink
Improve main README
Browse files Browse the repository at this point in the history
  • Loading branch information
Luke Wilson committed Dec 19, 2018
1 parent e1a1052 commit d4adc9d
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,24 @@ features, _Babel_ transpiling or _TypeScript_.

The project is divided into a number of modules:

- `tanagra-core` - common functionality required by the different serialization formats,
including the function for marking classes as _serializable_
- `tanagra-json` - serializes the data into `JSON` format
- `tanagra-protobuf` - serializes the data into `Google protobuffers` format (experimental)
- `tanagra-protobuf-redis-cache` - a helper library for storing serialized protobufs in _redis_
- `tanagra-auto-mapper` - walks the module tree in _node.js_ to build up a map of classes, meaning
the user doesn't have to specify the type to deserialize to (experimental)
- [tanagra-core](https://www.npmjs.com/package/tanagra-core) - common functionality required by the different
serialization formats, including the function for marking classes as _serializable_
- [tanagra-json](https://www.npmjs.com/package/tanagra-json) - serializes the data into `JSON` format
- [tanagra-protobuf](https://www.npmjs.com/package/tanagra-protobuf) - serializes the data into `Google protobuffers`
format (experimental)
- [tanagra-protobuf-redis-cache](https://www.npmjs.com/package/tanagra-protobuf-redis-cache) - a helper library
for storing serialized protobufs in _redis_
- [tanagra-auto-mapper](https://www.npmjs.com/package/tanagra-auto-mapper) - walks the module tree in _node.js_
to build up a map of classes, meaning the user doesn't have to specify the type to deserialize to (experimental)

## Installation

```bash
$ npm add --save tanagra-core
$ npm add --save tanagra-json
$ npm add --save tanagra-protobuf
$ npm add --save tanagra-protobuf-redis-cache
$ npm add --save tanagra-auto-mapper
```

## Usage
Expand Down Expand Up @@ -66,6 +72,6 @@ const encoded = json.encodeEntity(foo)

...

const decoded = json.decodeEntity(foo, Foo)
const decoded = json.decodeEntity(encoded, Foo)

```

0 comments on commit d4adc9d

Please sign in to comment.