Skip to content

Commit 67bc33c

Browse files
committed
Update README
1 parent 57c095b commit 67bc33c

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,35 @@
11
# typescript-starter-cycle
22
An opinionated starter for Cycle.js projects powered by TypeScript.
33

4+
## Opinions
5+
* TypeScript rocks. We use TypeScript as much as possible.
6+
* Visual Studio Code rocks. We use Visual Studio Code as the recommended editor.
7+
* Webpack rocks. We use webpack only.
8+
49
## Features
510
* TypeScript
611
* Webpack
7-
* Visual Studio Code integrations
8-
* Hot Module Reloading
912
* TypeStyle for styles
13+
* Simple routing with layouts
14+
* Hot Module Reloading
15+
* Async imports and dynamic routing
16+
* Visual Studio Code integrations
17+
18+
### Planned
1019
* Unit testing with Mocha and Chai
1120
* UI Integration tests with Cypress
12-
* Async imports and dynamic routing
13-
* Simple routing with layouts
21+
* Better README (duh!)
22+
23+
## Notes
1424

15-
##### Visual Studio Code Specifics
25+
### Visual Studio Code Specifics
1626
This repository is optimized for [Visual Studio Code](https://code.visualstudio.com/).
1727
We have launch configurations, an editor config file, and workspace settings.
1828

1929
To make full use of these, you need the following extensions:
2030
* [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome)
2131
* [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
2232

23-
##### Notes
33+
### Troubleshooting / Tips
2434
* If using on Windows machines, make sure you have the [build tools](https://github.com/felixrieseberg/windows-build-tools) ready before doing an `npm install`.
2535
* If hosting on a subdirectory, you need to change the `PROJECT_PUBLIC_PATH` in `webpack.config.js` only for production. You can do this by changing line #32 of the file to `var PROJECT_PUBLIC_PATH = __PROD__ ? '<your-public-path-here>' : '/';`

0 commit comments

Comments
 (0)