https://github.com/bevacqua/banksy

:city_sunrise: Street art between woofmark and horsey
https://github.com/bevacqua/banksy

Last synced: about 2 months ago
JSON representation

:city_sunrise: Street art between woofmark and horsey

• Host: GitHub
• URL: https://github.com/bevacqua/banksy
• Owner: bevacqua
• License: mit
• Created: 2015-07-22T09:02:36.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-07-19T15:29:13.000Z (over 8 years ago)
• Last Synced: 2024-10-02T13:18:06.897Z (2 months ago)
• Language: JavaScript
• Homepage: https://ponyfoo.com
• Size: 9.77 KB
• Stars: 10
• Watchers: 4
• Forks: 5
• Open Issues: 5
• Metadata Files:
  • Readme: readme.markdown
  • Changelog: changelog.markdown
  • License: license

Awesome Lists containing this project

• awesome-starred - bevacqua/banksy - :city_sunrise: Street art between woofmark and horsey (others)

README

        
# banksy

> Street art between [woofmark][2] and [horsey][1]

# Install

```shell

npm install banksy --save

```

# Features

Banksy helps you integrate the autocompletion features of [horsey][1] into a [woofmark][2] editor. It does this as unobtrusively as possible, by listening for a few events and running commands on your `editor` instance. Afterwards, the `banksy` instance destroys the `horse` when you're done with it, properly cleaning up after itself.

# Usage

Granted that you want to integrate a [horsey][1] instance into a [woofmark][2] editor, you can use `banksy` to alleviate the load, as it can be pretty confusing to make the two work in tandem.

# `banksy(el, options)`

After instantiating both the `editor` and the `horse`, use `banksy` to paint a bridge between the two.

```js

var editor = woofmark(el);

var horse = horsey(el);

var bridge = banksy(el, {

  editor: editor,

  horse: horse

});

```

That's it, now `horse` will work as you'd expect on all types of input for the `woofmark` editor.

# `bridge.destroy()`

To properly destroy the bridge, you can run `bridge.destroy()`. Note that this will destroy the `horse` instance as well, calling `horse.destroy()`.

# License

MIT

[1]: https://github.com/bevacqua/horsey

[2]: https://github.com/bevacqua/woofmark