@ea-lab/reactive-json 0.0.0 → 0.0.2

package/README.md

@@ -7,18 +7,73 @@ This lib lessens the need to write JS code for building frontend apps.
 With *reactive-json*, build your apps and forms frontend, embed them into your websites,
 and make them interactive with your backend.
 
-## Content
+TODO: make and insert a descriptive image.
 
-Lbrary and demo app for *reactive-json*.
+## How to use *reactive-json*
 
 The library can be:
 
-- included in your React project: use the provided `<ReactiveJsonRoot>` component
-  in your React app. This is the way to go if you want to use reactive-json plugins.
 - used as a standalone lib: simply load the dist files in your web page
   and it will work on the `<reactive-json>` HTML tags.
+- included in your React project: use the provided `<ReactiveJsonRoot>` component
+  in your React app. This is the way to go if you want to use reactive-json plugins.
+
+If you retrieved the source code of *reactive-json*, a demo app is available for use.
+
+```shell
+npm run dev
+```
+
+## How to install *reactive-json*
+
+### Standalone mode
+
+This mode only needs you to download the `/dist` folder and load the JS and CSS assets
+in your web pages.
+
+If the `/dist` is not available (probably because you pulled the library from
+the source code repository), you will have to generate it:
+
+```shell
+npm install && npm run build
+```
+
+### Library mode
+
+This mode is when you have a React project, and you want to include *reactive-json*
+as a part of your project.
 
-The app shows how to use *reactive-json*.
+First, install the lib:
+
+```shell
+npm install @ea-lab/reactive-json
+```
+
+And that's all!
+
+You will have to use the `<ReactiveJsonRoot>` component, with the appropriate
+options.
+
+```js
+import {ReactiveJsonRoot} from "@ea-lab/reactive-json";
+
+//...
+
+const YourComponent = () => {
+    return (
+        <div>
+          <ReactiveJsonRoot dataUrl={"/path/to/build.json"}/>
+        </div>
+    );
+};
+```
+
+## How to extend *reactive-json*
+
+To add new components, you must be in library mode. Indeed, the
+standalone mode is a fixed set of functionality. This can be changed later if
+a plugin system can be implemented; do not hesitate to contribute in this
+project if you know how to make it, it would be really appreciated!
 
 ## Project structure
 
@@ -28,13 +83,14 @@ The following is the specific documentation for the *reactive-json* project.
 
 ### Components `/lib/component`
 
-This is where the extensible code is located.
+This is where the main component code is located.
 
 We provided a basic set of components that people will mostly need.
 Those components usually wrap around famous third-party libs such as
 *React-Bootstrap* and *Chart.js*.
 
-Of course, you can add your own components, by following the same pattern.
+Of course, you can add your own components in your React project,
+by following the same pattern.
 
 #### Actions `/lib/component/action`
 
@@ -71,13 +127,17 @@ Generic reusable code.
 
 Contains the core functionality of *reactive-json*.
 
-This is where `ReactiveJsonRoot.jsx`* is.
-
-(* the main entrypoint component of *reactive-json*.)
+This is where `ReactiveJsonRoot.jsx` is.
 
 Usually, you won't need to edit its content. (But feel free to inspect it if you
 want to contribute!)
 
+### Public files `public`
+
+This directory contains files for the demo app.
+
+This directory is not included in the build.
+
 ### Demo app `src`
 
 All the demo app related code is here. This code is not included in the build.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ea-lab/reactive-json",
-  "version": "0.0.0",
+  "version": "0.0.2",
   "type": "module",
   "files": [
     "dist",