diff options
| author | Tom Needham <needham.thomas@gmail.com> | 2015-08-29 16:49:19 +0300 |
|---|---|---|
| committer | Thomas Müller <thomas.mueller@tmit.eu> | 2015-09-30 16:12:11 +0300 |
| commit | 0341b1e810513e8cb9349cd38fcbe43cc616562e (patch) | |
| tree | fd8b9bd1324cc4eb532adfb3e8d6dd0592622759 /README.md | |
| parent | 8fed9fe2232d7b456a82d1bbfccbe745553e06de (diff) | |
Add install, usage and contributors sections to readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 24 insertions, 5 deletions
@@ -1,13 +1,32 @@ -files_texteditor -================ +# Files_Texteditor +================== -A text editor app for ownCloud +[](https://travis-ci.org/owncloud/files_texteditor) +[](https://scrutinizer-ci.com/g/owncloud/files_texteditor/?branch=master) +[](https://scrutinizer-ci.com/g/owncloud/files_texteditor/?branch=master) -To see which files are editable, see [here](https://github.com/owncloud/files_texteditor/blob/master/js/editor.js) + +The original text editor app for ownCloud, based on [Ace](http://ace.c9.io/). + +Features: + - Syntax highlighting + - Autosave + - Syntax checking + - Responsive design (optimised on mobile and desktop) + +## Install +Simply copy the `files_texteditor` folder into the `apps` directory and enable the app within the ownCloud settings. + +## Usage +To use the editer, click on a [supported file](https://github.com/owncloud/files_texteditor/blob/master/js/editor.js#L6) within the Files app and the file will be loaded into the editor. Saving is automatic, but can also be triggered manually with `Ctrl+S` or `Cmd+S`. + +## Contributors +Maintainer: [Tom Needham](http://github.com/tomneedham) +Past contributors: [Thomas Müller](http://github.com/deepdiver1975) [Robin Appelman](http://github.com/icewind) [Jörn Friedrich Dreyer](http://github.com/butonic) [Vincent Petry](http://github.com/pvince) Preview apps ----- +------------ Apps can add side-by-side previews to the app for certain file types by using the preview api |