Skip to content

Commit

Permalink
Update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
swansontec committed Sep 18, 2018
1 parent abee382 commit 212b43f
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions README.md
@@ -1,14 +1,17 @@
# Edge Login
# Edge Core

This library implements the Edge login system. It runs inside a client application, and provides zero-knowledge backup for cryptographic keys and other secrets via a familiar password-based login system.

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

## Documentation

See https://developer.airbitz.co/javascript/

## Account Management UI

To quickly get up and running with the UI for account creation, login, and management, use [airbitz-core-js-ui](https://github.com/Airbitz/airbitz-core-js-ui/).
To quickly get up and running with the UI for account creation, login, and management, use [edge-login-ui-web](https://github.com/EdgeApp/edge-login-ui/tree/develop/packages/edge-login-ui-web) for the web or [edge-login-ui-rn](https://github.com/EdgeApp/edge-login-ui/tree/develop/packages/edge-login-ui-rn) for React Native.

## Setup

Expand All @@ -18,26 +21,26 @@ If you are on React Native, you must also do:

# Install native support libraries:
npm install --save react-native-fast-crypto react-native-fs
npm install --save git://github.com/Airbitz/react-native-randombytes.git
npm install --save git://github.com/Airbitz/react-native-tcp.git
npm install --save git://github.com/EdgeApp/react-native-randombytes.git
npm install --save git://github.com/EdgeApp/react-native-tcp.git

# Link support libraries into the native project files:
react-native link react-native-fast-crypto
react-native link react-native-fs
react-native link react-native-randombytes
react-native link react-native-tcp

The bundled library uses only ES5 feature thanks to [Bublé](https://buble.surge.sh), but we do require the following ES2015 features either natively or as polyfills:
The bundled library uses only ES5 features thanks to [Babel](https://babeljs.io/), but we do require the following ES2015 features either natively or as polyfills:

* Object.assign
* Promise
* Uint8Array
- `Object.assign`
- `Promise`
- `Uint8Array`

If you want to run in the browser, you must also have:

* fetch
* localStorage
* Window.crypto.getRandomNumbers
- `fetch`
- `localStorage`
- `Window.crypto.getRandomNumbers`

## Contributing

Expand Down

0 comments on commit 212b43f

Please sign in to comment.