Skip to content

Commit 503339d

Browse files
committed
Update README and a docs
1 parent e82833c commit 503339d

File tree

3 files changed

+33
-2
lines changed

3 files changed

+33
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,16 @@ Bash language server implementation based on [Tree Sitter][tree-sitter] and its
1515

1616
## Installation
1717

18-
Currently the client has only been implemented for Visual Studio Code. You can
19-
install it from the marketplace - It's called [Bash IDE][vscode-marketplace].
18+
```bash
19+
npm i -g bash-language-server
20+
```
21+
22+
### Clients
23+
24+
Clients have been implemented for:
25+
26+
- Visual Studio Code ([Bash IDE][vscode-marketplace])
27+
- Atom ([ide-bash][ide-bash]).
2028

2129
## Development Guide
2230

@@ -26,3 +34,4 @@ Please see [docs/development-guide][dev-guide] for more information.
2634
[tree-sitter-bash]: https://github.com/tree-sitter/tree-sitter-bash
2735
[vscode-marketplace]: https://marketplace.visualstudio.com/items?itemName=mads-hartmann.bash-ide-vscode
2836
[dev-guide]: https://github.com/mads-hartmann/bash-language-server/blob/master/docs/development-guide.md
37+
[ide-bash]: https://atom.io/packages/ide-bash

docs/development-guide.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,18 @@ below.
3535

3636
## Working on the client
3737

38+
### Visual Studio Code
39+
3840
Working on the client is simply a matter of starting vscode and using the Debug
3941
View to launch the `Launch Client` task. This will open a new vscode window with the
4042
extension loaded. It also looks for changes to your client code and recompiles
4143
it whenever you save your changes.
4244

45+
### Atom
46+
47+
See the [ide-bash][ide-bash] package for Atom. Due to how Atom packages are
48+
published the client lives in a separate repository.
49+
4350
## Working on the server
4451

4552
The easiest way right now is to simple compile and install the server globally
@@ -56,3 +63,4 @@ npm i -g .
5663
I'm open to suggestions on how to improve this workflow.
5764

5865
[LSP]: https://microsoft.github.io/language-server-protocol/
66+
[ide-bash]: https://github.com/mads-hartmann/ide-bash

docs/releasing.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Releasing
2+
3+
This is mainly a few notes to myself.
4+
5+
To release a new version of the vscode extension
6+
7+
```
8+
vsce publish x.x.x
9+
```
10+
11+
To release a new version of the server
12+
13+
- Bump the version in package.json
14+
- Upload to NPM: `npm publish`

0 commit comments

Comments
 (0)