Skip to content

Commit

Permalink
Update documentation to support phcode.dev
Browse files Browse the repository at this point in the history
  • Loading branch information
Hirse committed Aug 11, 2023
1 parent d949c33 commit ce41276
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 13 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
[![Build Status](https://github.com/Hirse/brackets-outline-list/actions/workflows/master.yml/badge.svg)](https://github.com/Hirse/brackets-outline-list/actions/workflows/master.yml)
[![Test Coverage](https://codecov.io/github/Hirse/brackets-outline-list/branch/master/graph/badge.svg?token=nGQjyBTrVh)](https://codecov.io/github/Hirse/brackets-outline-list)

<a href="http://brackets.io/"><img src="https://raw.githubusercontent.com/Hirse/brackets-outline-list/master/images/brackets.png" alt="Brackets" align="left" /></a>
<a href="https://brackets.io"><img src="https://raw.githubusercontent.com/Hirse/brackets-outline-list/master/images/brackets.png" alt="Brackets" align="left" /></a>
<a href="https://phcode.dev"><img src="https://raw.githubusercontent.com/Hirse/brackets-outline-list/master/images/pheonix.png" alt="Phoenix" align="left" /></a>

# Brackets Outline List
[Brackets][Brackets] Extension to display a list of the functions or definitions in the currently opened document. Settings for parameters and anonymous functions. See [features](#features) for a list of supported languages.
# Outline List
Extension for [Brackets][Brackets] and [Phoenix][Phoenix] to display a list of the functions or definitions in the currently opened document. Settings for parameters and anonymous functions. See [features](#features) for a list of supported languages.

## Screenshots
![JavaScript Outline](https://raw.githubusercontent.com/Hirse/brackets-outline-list/master/images/outline.png)
Expand Down Expand Up @@ -40,16 +41,13 @@

## Installation
### Latest Release
To install the latest _release_ of this extension use the built-in Brackets [Extension Manager][Brackets Extension Manager] which downloads the extension from the [extension registry][Brackets Extension Registry].

### Brackets npm Registry
The latest _release_ of this extension is also available on the [Brackets npm Registry][Brackets npm Registry].
To install the latest _release_ of this extension use the built-in [Extension Manager][Extension Manager] which downloads the extension from the [extension registry][Brackets Extension Registry].

### Latest Commit
To install the latest _commit_ of this extension use the built-in Brackets [Extension Manager][Brackets Extension Manager] which has a function to `Install from URL...` using this link: https://github.com/Hirse/brackets-outline-list/archive/master.zip.
To install the latest _commit_ of this extension use the built-in [Extension Manager][Extension Manager] which has a function to `Install from URL...` using this link: https://github.com/Hirse/brackets-outline-list/archive/master.zip.

## License
Brackets Outline List is licensed under the [MIT license][MIT].
Outline List is licensed under the [MIT license][MIT].

Used thirdparty software:
* [Espree][Espree] is licensed under the [BSD 2-Clause License][BSD-2-Clause]
Expand All @@ -59,10 +57,10 @@ Used thirdparty software:
* [php-parser][php-parser] is licensed under the [BSD-3-Clause license][BSD-3-Clause]


[Brackets]: http://brackets.io
[Brackets Extension Manager]: https://github.com/adobe/brackets/wiki/Brackets-Extensions
[Brackets]: https://brackets.io
[Phoenix]: https://phcode.dev
[Extension Manager]: https://github.com/adobe/brackets/wiki/Brackets-Extensions
[Brackets Extension Registry]: https://registry.brackets.io
[Brackets npm Registry]: https://github.com/zaggino/brackets-npm-registry

[Espree]: https://github.com/eslint/espree
[Ionicons]: http://ionicons.com
Expand Down
Binary file added images/phoenix.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "hirse.outline-list",
"version": "1.5.0",
"title": "Brackets Outline List",
"title": "Outline List",
"description": "Displays a list of the functions or definitions in the currently opened document. Works with CSS, CoffeeScript, HTML, Haxe, Jade, JavaScript, JSX, LESS, Markdown, PHP, Python, Ruby, SCSS, SVG, Stylus, and XML.",
"engines": {
"brackets": ">=1.8.0"
Expand Down

0 comments on commit ce41276

Please sign in to comment.