Code Tool version 2.0

Author: PolinaShneider

.gitignore

@@ -1,3 +1,4 @@
 node_modules/*
 npm-debug.log
-.idea/*
+.idea/*
+.DS_Store

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 CodeX Editor
+Copyright (c) 2018 CodeX
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,51 +1,77 @@
-![](https://badgen.net/badge/CodeX%20Editor/v1.0/gray)
+![](https://badgen.net/badge/CodeX%20Editor/v2.0/blue)
 
-# Code Plugin for CodeX Editor
+# Code Tool for CodeX Editor
 
-Paste code examples into your article.
+Code Tool for the [CodeX Editor](https://ifmo.su/editor) allows to include code examples in your articles.
 
-## Install via npm
+![](https://capella.pics/77cc593f-0384-4df2-b9d1-d9c7d6d96b7d.jpg)
 
-```shell
-npm i --save codex.editor.code
-```
+## Installation
 
-#### Connect with Webpack
+### Install via NPM
 
-Include module in your application
+Get the package
 
-```js
-require('codex.editor.code');
+```shell
+npm i --save-dev codex.editor.code
 ```
 
-Include CSS file
+Include module at your application
 
-```css
-@import url("~codex.editor.code/lib/code.css");
+```javascript
+const RawTool = require('codex.editor.code');
 ```
 
-## Install directly
+### Download to your project's source dir
+
+1. Upload folder `dist` from repository
+2. Add `dist/bundle.js` file to your page.
 
-1. Download folder `lib` from repository
-2. Add `lib/bundle.js` and `lib/bundle.css` files to your page.
+### Load from CDN
 
-## CodeX Editor
+You can load specific version of package from [jsDelivr CDN](https://www.jsdelivr.com/package/npm/codex.editor.code).
 
-API oriented, open-source, block-styled Edtior.
+`https://cdn.jsdelivr.net/npm/[email protected]`
 
-https://github.com/codex-team/codex.editor
+Require this script on a page with CodeX Editor.
 
-## Authors
+```html
+<script src="..."></script>
+```
+
+## Usage
+
+Add a new Tool to the `tools` property of the CodeX Editor initial config.
+
+```javascript
+var editor = CodexEditor({
+  ...
+  
+  tools: {
+    ...
+    code: Code,
+  }
+  
+  ...
+});
+```
 
-We are small team of Web-developing fans consisting of IFMO students and graduates located in St. Petersburg, Russia.
-Fell free to give us a feedback on <a href="mailto::[email protected]">[email protected]</a>
+## Config Params
 
-https://ifmo.su
+| Field       | Type     | Description                    |
+| ----------- | -------- | -------------------------------|
+| placeholder | `string` | Code Tool's placeholder string |
 
-### Follow us!
+## Output data
 
-VK: https://vk.com/codex_team
+This Tool returns raw code.
 
-Telegram: https://t.me/codex_team
+```json
+{
+    "type" : "code",
+    "data" : {
+        "code": "body {\n font-size: 14px;\n line-height: 16px;\n}",
+    }
+}
+```
 
-Instagram: https://www.instagram.com/codex_team