treege 0.10.4 → 0.11.1

package/CHANGELOG.md

@@ -1,8 +1,4 @@
 # [Versions](https://github.com/Tracktor/treege/releases)
 
-## v0.10.4
-- **[build]** : Exclude unused `public` directory from build
-- **[build]** : Exclude unused `App.tsx` from build
-- **[refactor]** : Improve fetching handler
-- **[refactor]** : Change icon save button
-- **[fix]** : Infinite loading when reset tree white `API` context
+## v0.11.1
+- **[build]** : Improve build process

package/README.md

@@ -52,14 +52,49 @@ export default App;
 
 | Props         | Type   | Default   | Required | Detail                                                                                        |
 |---------------|--------|-----------|----------|-----------------------------------------------------------------------------------------------|
-| authToken     | string | undefined | false    | Authentication token                                                                          |
-| endPoint      | string | undefined | false    | Endpoint for API communication                                                                |
+| backendConfig | object | undefined | false    | Backend configuration. Only necessary if you want backend communication.                      |
 | initialTreeId | string | undefined | false    | If provided, this will fetch initial tree id. Cannot provided with `initialTree` in same time |
 | initialTree   | object | undefined | false    | Initial tree data. Cannot provided with `initialTreeId` in same time                          |
 
-## Generate form from Treege data
 
-Form can be easily generated with the React library [treege-consumer](https://github.com/Tracktor/treege-consumer)
+#### `backendConfig`
+| Props     | Type   | Default   | Required | Detail                                                      |
+|-----------|--------|-----------|----------|-------------------------------------------------------------|
+| baseUrl   | string | undefined | true     | Base url for API communication. ex : https://api.treege.com |
+| authToken | string | undefined | false    | Authentication token                                        |
+| endpoints | object | undefined | false    | Endpoints configuration                                     |
+
+#### `endpoints`
+| Props     | Type   | Default   | Required        | Detail                                                      |
+|-----------|--------|-----------|-----------------|-------------------------------------------------------------|
+| workflow  | string | undefined | "/v1/workflow"  | Endpoint for `get/post/patch` single `workflow`             |
+| workflows | string | undefined | "/v1/workflows" | Endpoint for get all workflows. It is a array on `workflow` |
+
+Backend model need to be compatible with the following interface:
+
+```typescript
+interface Workflow {
+  id: string;
+  name: string;
+  description: string;
+  tree: Tree;
+}
+```
+
+`Tree` is a JSON object generated by `Treege` with the following interface:
+
+```typescript
+interface Tree {
+  name: string;
+  attributes: any;
+  children: Tree[];
+  treeId?: string;
+}
+```
+
+## How use Treege data ?
+
+You can easily generate a form with the `React library` [treege-consumer](https://github.com/Tracktor/treege-consumer) or use our own application !
 
 ## Local installation