Merge pull request #5 from kochavalabs/release

Release/v0.1.0

Author: kbartush

.circleci/config.yml

@@ -0,0 +1,70 @@
+version: 2
+
+jobs:
+  build:
+    docker:
+      - image: circleci/node:latest
+    steps:
+      - checkout
+      - run:
+          name: Update npm
+          command: 'sudo npm install -g npm@latest'
+      - restore_cache:
+          key: dependency-cache-{{ checksum "package.json" }}
+      - run:
+          name: NPM Install
+          command: npm install
+      - run:
+          name: NPM Build
+          command: npm run build
+      - save_cache:
+          key: dependency-cache-{{ checksum "package.json" }}
+          paths:
+            - node_modules
+            - dist
+  test:
+    docker:
+      - image: circleci/node:latest
+    steps:
+      - checkout
+      - restore_cache:
+          key: dependency-cache-{{ checksum "package.json" }}
+      - run:
+          name: Lint
+          command: npm run lint
+      - run:
+          name: Test
+          command: npm test
+  publish-dev:
+    docker:
+      - image: circleci/node:latest
+    steps:
+      - checkout
+      - restore_cache:
+          key: dependency-cache-{{ checksum "package.json" }}
+      - run:
+          name: Set Develop Version
+          command: git rev-parse develop | cut -c1-10 | xargs -I[] ./node_modules/package-tagger/index.js dev.[]
+      - run:
+          name: Authenticate with registry
+          command: echo "//registry.npmjs.org/:_authToken=$npm_TOKEN" > .npmrc
+      - run:
+          name: Publish package
+          command: npm publish --tag develop
+
+workflows:
+  version: 2
+  build_and_test:
+    jobs:
+      - build
+      - test:
+          requires:
+            - build
+      - publish-dev:
+          requires:
+            - build
+            - test
+          filters:
+            branches:
+              only: develop
+

.gitignore

@@ -1,2 +1,3 @@
 node_modules/
 dist/
+package-lock.json

README.md

@@ -1,2 +1,42 @@
-# xdr-js-serialize
-Javascript XDR Codec
+# XDR JS Serialize
+
+[![CircleCI](https://circleci.com/gh/kochavalabs/xdr-js-serialize.svg?style=svg)](https://circleci.com/gh/kochavalabs/xdr-js-serialize)
+
+Xdr-js-serialize is a library for facilitating (de)serialization between the
+[XDR](https://en.wikipedia.org/wiki/External_Data_Representation) format and
+Javascript Dictionaries.
+
+This repository is best used in tandom with [xdr-codegen](https://github.com/kochavalabs/xdr-codegen)
+for anything beyond basic xdr manipulation.
+
+## Installation
+
+This library can be added to your project by using npm to install the
+xdr-js-serialize package.
+
+```bash
+npm install xdr-js-serialize
+```
+
+## Usage
+
+```js
+import types from 'xdr-js-serialize'
+
+const string = new types.Str('asdf')
+
+console.log(string.toJSON())
+console.log(string.toXDR('hex'))
+
+// console:
+// asdf
+// 0000000461736466
+```
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+
+## Notes
+
+- The XDR Quad type is currently not supported