Skip to content
This repository has been archived by the owner on May 8, 2020. It is now read-only.

Commit

Permalink
feat(cli): Updated quickstart docs, bumped to latest toolchain version
Browse files Browse the repository at this point in the history
  • Loading branch information
zakhenry committed Jun 8, 2016
1 parent fc00bde commit a8ad947
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 15 deletions.
10 changes: 10 additions & 0 deletions docs/guide/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: CLI
date: 2016-06-08
collection: guide
collectionSort: 1
layout: guide.hbs
-----------------

## Docs coming soon
For now, you can run `u help` or just `help` when in the toolchain shell to get available commands
19 changes: 13 additions & 6 deletions docs/guide/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,19 @@ collectionSort: 0
layout: guide.hbs
-----------------

## Prerequisites
* Node installed (v6.2.0 has been verified, may work in earlier versions)

## Installation

Ubiquits uses a commandline tool `u` to initialize a new project, and manage the building/watching/deployment/debugging etc within it's own shell.

To get started, run the following command in your console *in an empty directory*:

```bash
git clone https://github.com/ubiquits/ubiquits.git myapp \
&& cd myapp \
&& rm -rf .git \
&& git init \
&& npm i \
&& u watch
npm install -g @ubiquits/toolchain && u
```

This will install the toolchain then initialize a new project by cloning the boilerplate, and running installation.

For more information, visit the [cli guide page](/guide/cli)
17 changes: 8 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,17 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/ubiquits/core.git"
"url": "git+https://github.com/ubiquits/ubiquits.git"
},
"keywords": [
"ubiquits"
],
"author": {
"name": "Zak Henry",
"email": "[email protected]",
"url": "http://twitter.com/zak"
},
"author": "Zak Henry <[email protected]> (http://twitter.com/zak)",
"license": "MIT",
"bugs": {
"url": "https://github.com/ubiquits/core/issues"
"url": "https://github.com/ubiquits/ubiquits/issues"
},
"homepage": "https://github.com/ubiquits/core#readme",
"homepage": "https://github.com/ubiquits/ubiquits#readme",
"dependencies": {
"@angular/common": "^2.0.0-rc.1",
"@angular/compiler": "^2.0.0-rc.1",
Expand All @@ -53,6 +49,9 @@
"zone.js": "^0.6.12"
},
"devDependencies": {
"@ubiquits/toolchain": "^0.0.12"
"@ubiquits/toolchain": "^0.1.0"
},
"directories": {
"doc": "docs"
}
}

0 comments on commit a8ad947

Please sign in to comment.