From 6aec1544d7e769cdf1d49086afda8b88f114546a Mon Sep 17 00:00:00 2001 From: Machiste Quintana Date: Thu, 30 Apr 2015 21:31:15 -0400 Subject: [PATCH] WIP: Improve Readme --- README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 76 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 33e34f29..39379f8c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,81 @@ -# Tree View package [![Build Status](https://travis-ci.org/atom/tree-view.svg?branch=master)](https://travis-ci.org/atom/tree-view) +# Tree View -Explore and open files in the current project. +[![Build Status](https://travis-ci.org/atom/tree-view.svg?branch=master)](https://travis-ci.org/atom/tree-view) +[![Dependency Status](https://david-dm.org/atom/tree-view.svg)](https://david-dm.org/atom/tree-view) + +Explore and manage files and folders in the current project. + +![Tree View screenshot](https://f.cloud.github.com/assets/671378/2241932/6d9cface-9ceb-11e3-9026-31d5011d889d.png) + +This is a package for [Atom](https://atom.io), a hackable text editor for the 21st Century. + +## Usage Press `cmd-\` to open/close the Tree view and `ctrl-0` to focus it. -When the Tree view has focus you can press `a`, `m`, or `delete` to add, move -or delete files and folders. +When the Tree view has focus you can press `a`, `m`, or `delete` to add, move or delete files and folders. + +### Commands + +Command | Selector | Description +-------------------|----------|------------ +`tree-view:toggle` | TODO | Shows or hides the Tree View. +`tree-view:toggle-focus` | TODO | Toggles focus between the Tree View and the active pane. +`tree-view:reveal-active-file` | TODO | TODO +`tree-view:copy` | TODO | TODO +`tree-view:cut` | TODO | TODO +`tree-view:paste` | TODO | TODO +`tree-view:move` | TODO | TODO +`tree-view:rename` | TODO | TODO +`tree-view:add-file` | TODO | TODO +`tree-view:add-folder` | TODO | TODO +`tree-view:duplicate` | TODO | TODO +`tree-view:remove` | TODO | TODO +`tree-view:copy-full-path` | TODO | TODO +`tree-view:copy-project-path` | TODO | TODO +`tree-view:expand-directory` | TODO | TODO +`tree-view:recursive-expand-directory` | TODO | TODO +`tree-view:collapse-directory` | TODO | TODO +`tree-view:recursive-collapse-directory` | TODO | TODO +`tree-view:open-selected-entry` | TODO | TODO +`tree-view:open-selected-entry-right` | TODO | TODO +`tree-view:open-selected-entry-left` | TODO | TODO +`tree-view:open-selected-entry-up` | TODO | TODO +`tree-view:open-selected-entry-down` | TODO | TODO +`tree-view:open-selected-entry-in-pane-1` | TODO | TODO +`tree-view:open-selected-entry-in-pane-2` | TODO | TODO +`tree-view:open-selected-entry-in-pane-3` | TODO | TODO +`tree-view:open-selected-entry-in-pane-4` | TODO | TODO +`tree-view:open-selected-entry-in-pane-5` | TODO | TODO +`tree-view:open-selected-entry-in-pane-6` | TODO | TODO +`tree-view:open-selected-entry-in-pane-7` | TODO | TODO +`tree-view:open-selected-entry-in-pane-8` | TODO | TODO +`tree-view:open-selected-entry-in-pane-9` | TODO | TODO +`tree-view:toggle-vcs-ignored-files` | TODO | TODO +`tree-view:toggle-side` | TODO | TODO +`tree-view:toggle-ignored-names` | TODO | TODO +`tree-view:open-in-new-window` | TODO | TODO +`tree-view:show-in-file-manager` | TODO | TODO +`tree-view:remove-project-folder` | TODO | TODO + +### Keybindings + +TODO + +### Configuration + +TODO + +### Styles + +TODO + +## Contributing +Always feel free to help out! Whether it's [filing bugs and feature requests] +or working on some of the [open issues], Atom's [contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) +will help get you started while the [guide for contributing to packages](https://github.com/atom/atom/blob/master/docs/contributing-to-packages.md) +has some extra information. + +## License -![](https://f.cloud.github.com/assets/671378/2241932/6d9cface-9ceb-11e3-9026-31d5011d889d.png) +[MIT License](http://opensource.org/licenses/MIT) - see the [LICENSE]([Put full path to file here]LICENSE.md) for more details.