Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
timfjord committed Jul 6, 2023
1 parent d03c82e commit 5d5b796
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitattributes
Expand Up @@ -2,3 +2,4 @@
# archive files. See http://git-scm.com/docs/gitattributes for details.

/tests/ export-ignore
/docs/ export-ignore
11 changes: 10 additions & 1 deletion README.md
Expand Up @@ -8,7 +8,7 @@ Go to an alternate file and more.
## Features

- jump between test and implementation files
- open/jump to an alternate file from the SideBar
- open/jump to an alternate file from the Side Bar
- `.projections.json` file support (including JSON schema validation)
- built-in projections for Elixir, Ruby, and Sublime package development
- work on all platforms
Expand All @@ -26,6 +26,15 @@ And the main idea is to:

> provide granular project configuration using "projections".
The package exposes the following commands to work with projections:

- `projectionist_open_alternate` - open an alternate file for the current file.
In Sublime Text 4 this command supports `"mode": "side_by_side"`, to open an alternate file in a side-by-side view.
This command is also available in the Command Palette (`Projectionist: Open alternate`) as well as in the Side Bar.
In the Side Bar there is also an option to jump(reveal in Side Bar) an alternate file rather than open it.

Check [Default.sublime-commands](https://github.com/timfjord/Projectionist/blob/main/Default.sublime-commands) to see the list of all available commands.

### What are projections?

Projections are maps from filenames and globs to sets of properties describing the file.
Expand Down

0 comments on commit 5d5b796

Please sign in to comment.