Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nick-denry committed Mar 8, 2018
1 parent 04f0352 commit d21e3c7
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 9 deletions.
38 changes: 36 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,36 @@
# yii2-ckeditor-roxyfileman
Roxy File Manager integration with CKEditor for yii2
<p align="center">
<a href="https://github.com/yiisoft" target="_blank">
<img src="https://avatars0.githubusercontent.com/u/993323" height="100px">
</a>
<h1 align="center">Roxy File Manager integration with CKEditor for yii2</h1>
<br>
</p>

Installation
------------

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```
php composer.phar require --prefer-dist nick-denry/yii2-ckeditor-roxyfileman
```

or add

```
"nick-denry/yii2-ckeditor-roxyfileman": "^0.1.0"
```

to the require section of your `composer.json` file.

Docs
---
* [Module configuration](docs/module.md)
* [Integrate to CKEditor](docs/ckeditor.md)
* [Standalone](docs/standalone.md)

Screenshot
---
![RoxyFileManager ckeditor](docs/screenshot.png)
14 changes: 7 additions & 7 deletions docs/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Module configure
### Example
Add to config file:
```
'modules' => [
'roxymce' => [
'class' => 'nickdenry\ckeditorRoxyFileman\Module',
'uploadFolder' => '@frontend/web/uploads/images',
'uploadUrl' => '/uploads/images',
],
],
'modules' => [
'roxymce' => [
'class' => 'nickdenry\ckeditorRoxyFileman\Module',
'uploadFolder' => '@frontend/web/uploads/images',
'uploadUrl' => '/uploads/images',
],
],
```
Binary file modified docs/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d21e3c7

Please sign in to comment.