Commit 2a328480 authored by Amaury Martiny's avatar Amaury Martiny
Browse files

Add basic readme files

parent 876fc70a
# fether-electron
Electron wrapper around `fether-react`.
# fether-react
Fether React SPA app.
......@@ -19,7 +19,7 @@ import light from 'light-hoc';
* A HOC on light.js to get the current balance.
*
* @example
* @withBalance
* @withBalance()
* class MyComponent extends React.Component{
*
* }
......
# fether-ui
UI components used in Fether.
## TODO
Use Semantic UI (or another UI libray) as a base, instead of recoding everything ourselves.
......@@ -3,3 +3,23 @@
A HOC to use [@parity/light.js](https://github.com/parity-js/light.js) with React. Basically the equivalent of oo7-react for Observables.
Probably this should go inside its own repo.
## Usage
The libray provides a higher-order component to use these Observables easily with React apps.
```javascript
import light from '???'; // ??? to be decided
import { syncing$ } from '@parity/light.js';
@light({
syncingVariable: syncing$
})
class MyClass extends React.Component {
render() {
return <div>{JSON.stringify(this.props.syncingVariable)}</div>;
}
}
```
The UI will automatically update when the syncing state changes.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment