golfnet-editor/README.md

## Features

# golfnet-editor

## Features

* Create resizable Post-its on the Canvas (squared and circled) via
  * Palette
  * Double Click (latest element type will be respected)
* Change the color of Post-its
* Create simple Text Boxes on the Canvas
* Create grouping frame elements on the Canvas
* Add external image resources on the Canvas

## Installation

Install the package to include it into your web application

```sh
$ Add Node Module name here
```

## Usage

To get started, create a [postit-js](https://github.com/pinussilvestrus/postit-js) instance
and render a post-it board into your web application

```javascript
import 'postit-js-core/assets/postit-js.css';

import PostItModeler from 'postit-js-core/lib/Modeler';

let xml; // my post-it xml 

const modeler = new PostItModeler({
  container: '#canvas',
  keyboard: {
    bindTo: window,
  },
  type:'Panel' //[eg. 'Panel','Net']
});

modeler.importXML(xml).then(function() {
  console.log('board rendered');
}).catch(function(error) {
  console.error('could not import postit board', err);
});
```

For using `postit-js` inside your web application you'll need a source code bundler, e.g. [webpack](https://webpack.js.org/). Checkout the [example](./example) for getting inspiration. 

### Development Setup

Spin up the application for development, all strings attached:

```sh
$ npm install
$ cd  example
$ npm install
$ npm run dev
```

## License

MIT
# golfnet-editor