readme

Author: ukrbublik

README.md

@@ -1 +1,34 @@
-To be done ...
+# react-awesome-query-builder
+User-friendly React component to build queries.
+
+Forked from [https://github.com/fubhy/react-query-builder](https://github.com/fubhy/react-query-builder)
+
+
+### Install
+`npm i react-awesome-query-builder`
+
+
+### Demo
+[Demo](https://ukrbublik.github.io/react-awesome-query-builder)
+
+
+### Development
+To build the component locally, clone this repo then run:
+
+`npm install`
+`npm run examples`
+
+Then open localhost:3001 in a browser.
+
+Scripts:
+- `npm run build-global` - Builds with webpack the self contained pack of the component. Output path: `build/global`
+- `npm run build-npm` - Builds a npm module. Output path: `build/global`
+- `npm run build-examples` - Builds with webpack the examples. Output path: `examples`
+- `npm run examples` - Builds with webpack the examples and runs a dev-server on localhost:3001.
+
+The repo sticks in general to the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).
+
+
+### License
+MIT. See also `LICENSE.txt`
+