Skip to content

Commit 6cb7440

Browse files
committed
doc: fix links
1 parent 978d407 commit 6cb7440

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@
2727

2828
Provides editor support for ```tw`...```` tagged template syntax including:
2929

30-
- Autocomplete for tailwind, beamwind and oceanwind classes
30+
- Autocomplete for [twind](https://github.com/tw-in-js/twind) classes
3131
- Warnings on unknown classes
3232
- Quick fixes for misspelled property names.
3333

3434
## Installation
3535

3636
```sh
37-
npm install --save-dev @twind/typescript-plugin
37+
npm install --save-dev typescript @twind/typescript-plugin
3838
```
3939

4040
## Usage
@@ -43,9 +43,7 @@ This plugin requires TypeScript 2.4 or later. It can provide intellisense in bot
4343

4444
### With VS Code
4545

46-
Just install the [VS Code tailwindjs extension](https://github.com/tw-in-js/core/packages/vscode). This extension adds syntax highlighting and IntelliSense for styled components in JavaScript and TypeScript files.
47-
48-
If you are using a [workspace version of TypeScript](<(https://code.visualstudio.com/Docs/languages/typescript#_using-newer-typescript-versions)>) however, you must manually install the plugin along side the version of TypeScript in your workspace.
46+
Currently you must manually install the plugin along side TypeScript in your workspace.
4947

5048
Then add a `plugins` section to your [`tsconfig.json`](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) or [`jsconfig.json`](https://code.visualstudio.com/Docs/languages/javascript#_javascript-project-jsconfigjson)
5149

@@ -61,7 +59,7 @@ Then add a `plugins` section to your [`tsconfig.json`](http://www.typescriptlang
6159
}
6260
```
6361

64-
Finally, run the `Select TypeScript version` command in VS Code to switch to use the workspace version of TypeScript for VS Code's JavaScript and TypeScript language support. You can find more information about managing typescript versions [in the VS Code documentation](https://code.visualstudio.com/Docs/languages/typescript#_using-newer-typescript-versions).
62+
Finally, run the `Select TypeScript version` command in VS Code to switch to use the workspace version of TypeScript for VS Code's JavaScript and TypeScript language support. You can find more information about managing typescript versions [in the VS Code documentation](https://code.visualstudio.com/docs/typescript/typescript-compiling#_using-the-workspace-version-of-typescript).
6563

6664
### With Sublime
6765

@@ -168,7 +166,7 @@ Now strings tagged with either `tw` and `cx` will have IntelliSense.
168166

169167
Thanks for being willing to contribute!
170168

171-
> This project is free and open-source, so if you think this project can help you or anyone else, you may [star it on GitHub](https://github.com/tw-in-js/core). Feel free to [open an issue](https://github.com/tw-in-js/core/issues) if you have any idea, question, or you've found a bug.
169+
> This project is free and open-source, so if you think this project can help you or anyone else, you may [star it on GitHub](https://github.com/tw-in-js/typescript-plugin). Feel free to [open an issue](https://github.com/tw-in-js/typescript-plugin/issues) if you have any idea, question, or you've found a bug.
172170
173171
**Working on your first Pull Request?** You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
174172

0 commit comments

Comments
 (0)