Skip to content
This repository was archived by the owner on May 26, 2023. It is now read-only.

Commit 14a7996

Browse files
committed
Update README.md and LICENSE
1 parent 50ab38f commit 14a7996

File tree

2 files changed

+33
-6
lines changed

2 files changed

+33
-6
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright {yyyy} {name of copyright owner}
189+
Copyright 2018 WillowTree Inc.
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

+32-5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,16 @@
99
[![Npm downloads](https://img.shields.io/npm/dt/@willowtreeapps/wist.svg?style=flat-square)](https://www.npmjs.com/package/@willowtreeapps/wist)
1010
[![Travis branch](https://img.shields.io/travis/willowtreeapps/wist.svg?style=flat-square)](https://travis-ci.org/willowtreeapps/wist)
1111

12-
Wist is a linter for identifying and reporting errors in Brightscript code. It helps you identify errors before you upload code to your Roku.
12+
13+
[Website](https://willowtreeapps.github.io/wist/) |
14+
[Configuring](https://willowtreeapps.github.io/wist/user-guide/getting-started) |
15+
[Rules](https://willowtreeapps.github.io/wist/user-guide/rules/) |
16+
[Contributing](https://willowtreeapps.github.io/wist/developer-guide/contributing/) |
17+
[Reporting Bugs](https://willowtreeapps.github.io/wist/developer-guide/contributing/#reporting-bugs) |
18+
[Code of Conduct](https://willowtreeapps.github.io/wist/developer-guide/contributing/code-of-conduct)
19+
20+
21+
Wist is a linter for identifying and reporting errors found in Brightscript code. It helps you identify errors before you upload code to your Roku.
1322

1423
**For full documentation, please see our user and developer guides [here](https://willowtreeapps.github.io/wist/)**
1524

@@ -36,13 +45,12 @@ The easiest and best way to use Wist, is through our editor clients.
3645
* [Atom IDE Brightscript](https://github.com/willowtreeapps/atom-ide-brightscript)
3746
* [VSCode IDE Brightscript](https://github.com/willowtreeapps/vscode-ide-brightscript)
3847

39-
You can install them through their respective package managers and work out of the box with a `.wistrc.json` in your root directory.
48+
You can install them through their respective package managers and work out of the box with a `.wistrc.json` included in your root directory.
4049

4150
## Standalone installation
4251

4352
We recommend taking this approach if you if you want to include Wist as part of your project's build pipeline. Wist is available via as an NPM package and can be installed like so:
4453

45-
4654
```
4755
$ npm install -g @willowtreeapps/wist
4856
```
@@ -96,7 +104,7 @@ This will generate a `.wistrc.json` file in your directory. In it, you'll see so
96104
}
97105
```
98106

99-
These configures the sort of errors that the [rules engine](https://willowtreeapps.github.io/wist/user-guide/rules-engine) reports back. There are several other [rules](https://willowtreeapps.github.io/wist/user-guide/rules/) that can be configured. See the documentation for the full list.
107+
These configures the sort of errors that the [rules engine](https://willowtreeapps.github.io/wist/user-guide/rules-engine) reports back. There are several other rules that can be configured. See the [documentation](https://willowtreeapps.github.io/wist/user-guide/rules/) for the full list.
100108

101109
Once your `.wistrc.json` has been configured to your liking. Invoke wist on your Brightscript file.
102110

@@ -106,12 +114,13 @@ $ wist yourfile.brs
106114

107115
## Wist format
108116

109-
Wist format is a code formatter built into Wist.
117+
Wist format or `wist-fmt` is an opinionated code formatter built into Wist. It works by traversing your codes abstract syntax tree and reprinting it with the appropriate whitespace after. `wist-fmt` can be run in a pre-commit hook, or in your CI environments to ensure your codebase has a consistent code style.
110118

111119
```
112120
Usage: wist-fmt [options] [file.brs]
113121
114122
-i, --indent Int Number of tokens to indent
123+
--use-tabs Indent with tabs
115124
-h, --help Show help
116125
-v, --version Show version information
117126
```
@@ -133,3 +142,21 @@ wist-fmt -i 2 yourfile.brs
133142
Contributions are welcome. Please see the [Contributing guidelines](CONTRIBUTING.md).
134143

135144
Wist has adopted a [Code of Conduct](CODE_OF_CONDUCT.md) defined by the [Contributor Covenant](http://contributor-covenant.org). Please see our [Code of Conduct](/CODE_OF_CONDUCT.md) as well as our [Contributing Guidelines ](/CONTRIBUTING.md) for more information.
145+
146+
## License
147+
148+
```
149+
Copyright 2018 WillowTree Inc.
150+
151+
Licensed under the Apache License, Version 2.0 (the "License");
152+
you may not use this file except in compliance with the License.
153+
You may obtain a copy of the License at
154+
155+
http://www.apache.org/licenses/LICENSE-2.0
156+
157+
Unless required by applicable law or agreed to in writing, software
158+
distributed under the License is distributed on an "AS IS" BASIS,
159+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
160+
See the License for the specific language governing permissions and
161+
limitations under the License.
162+
```

0 commit comments

Comments
 (0)