Skip to content

Commit

Permalink
Updated: README
Browse files Browse the repository at this point in the history
  • Loading branch information
danielsss committed Dec 13, 2023
1 parent 567b143 commit 21e5ccc
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,18 @@

This project is a lightweight official software development kit for JavaScript/Typescript which is available for browsers and Node.js.

This library implements various functions which are similar to our UI applications and You might know the basic concepts of this library if you've used the application before.
This library implements various functions which are similar to our UI applications, and You might know the basic concepts of this library if you've used the application before.

In order to use it conveniently, an essential concept you should know is that everything is a component and each one of them has a unique component ID. You can add a child node under the components, however, the Markers and Notes can only be attached to the components.

Eventually, Our UI apps could be used to open the `*.xmind` file generated by this tool.
Eventually, Our UI apps could be used to open the `*.xmind` file generated by this tool.


## Recommendations

* [Flatwhite](https://xmind.works) - It's a lightweight online `Mind-Map` tool comes with AI features which helps you to build everything you wanted.
* [Xmind-generator](https://github.com/xmindltd/xmind-generator) — If you are looking for a tool specifically designed for `Mind-Map` generation, `Xmind Generator` is an official package that prioritizes this functionality, featuring a modern and lightweight API.

Last but not least, we also provided the [Online 🌐 Mind-Mapping](https://xmind.works) for anyone who wants to explore something new.

## Supported Platforms

Expand Down

0 comments on commit 21e5ccc

Please sign in to comment.