jsmind/es6/README-en.md

jsMind is a pure javascript library for mindmap, it base on html5 canvas. jsMind was released under BSD license, you can embed it in any project, if only you observe the license.

# jsMind ES6 Version

[[中文](README.md)] | [English]

jsMind is now written in ES6 code, the source code is in `/src`, and the dist directory is `/es6`.


### Compatibility

All features in the JS version are fully compatible in the ES6 version.

### Migration

If you use `jsMind` via `NPM`, no migration is required, we just changed the `main` file to `es6/jsmind.js`

If you reference `jsMind` from CDN, the only thing you need to do is change the url from `js/*.js` to `es6/*.js`.

E.g.

```html
<!-- before -->
<script type="text/javascript" src="//cdn.jsdelivr.net/npm/jsmind/js/jsmind.js"></script>

<!-- after -->
<script type="text/javascript" src="//cdn.jsdelivr.net/npm/jsmind/es6/jsmind.js"></script>
```

### Deprecation

The legacy version of jsmind and plugins have been moved to `/js-legacy`. we will no longer update them, and will remove them one day in the future. It's recommended that everyone use the latest version to follow continuous feature updates and bug fixes.

### Local build

You probably notice that there is no `js` files or `es6` files in the directory `/es6`. Yes, we publish the dist file to `NPM` but don't store them in the repo. 

You can download the resources from CDN, or build them locally by running `npm run build` in the root dir of the project. Read [development doc](../docs/en/5.development.md) to get the detail about code building.