Skip to content

Commit 97b59d8

Browse files
committed
update README
1 parent 7f817b8 commit 97b59d8

File tree

1 file changed

+12
-26
lines changed

1 file changed

+12
-26
lines changed

README.md

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,30 @@
44

55
A minimal frontend boilerplate, emphasizing workflow.
66

7-
## About
8-
9-
Outset is **a workflow moreso than it is a framework.** It aims to exist in the background, not the spotlight.
10-
11-
All the magic happens in the [`gulpfile`](https://github.com/callmecavs/outset/blob/master/template/gulpfile.js). The actual HTML/CSS/JS [code](https://github.com/callmecavs/outset/tree/master/template/src) provides some useful but minimal boilerplate. A more detailed explanation of both can be found [here](https://github.com/callmecavs/outset/blob/master/DETAIL.md).
12-
13-
Outset eliminates a number of annoyances, while making very few assumptions. It is developed with the intention of being the solution to writing frontend code instantly, without worrying about setup, or configuring a build system.
14-
157
## Getting Started
168

179
In your terminal:
1810

1911
```shell
20-
# using node and npm
2112
# install outset globally
13+
$ npm i outset -g
2214

23-
$ npm install outset -g
15+
# use the `outset` command to create a project
16+
# unless a path is specified, the template is copied to the CWD
17+
$ outset [path]
2418

25-
# use the outset command from the CLI to scaffold a project
26-
# template files are copied to the CWD, unless a path is specified
19+
# enter the new project directory
20+
$ cd [path]
2721

28-
$ outset [path]
22+
# install dependencies
2923
$ npm i
30-
$ gulp
31-
```
32-
33-
In your browser:
3424

35-
```shell
36-
http://localhost:3000/
25+
# start building
26+
$ npm start
3727
```
3828

39-
Work in the `src` folder, deploy from the `dist` folder.
40-
41-
## Browser Support
42-
43-
Targeting evergreen browsers and **IE10+**.
29+
In your browser: [http://localhost:1234/](http://localhost:1234/)
4430

45-
Note that this boilerplate **doesn't detect browsers or their features**.
31+
## License
4632

47-
[![Built With Love](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com)
33+
[MIT](https://opensource.org/licenses/MIT). © 2022 Michael Cavalea

0 commit comments

Comments
 (0)