diff --git a/docs/guide/cli.md b/docs/guide/cli.md new file mode 100644 index 0000000..88bfead --- /dev/null +++ b/docs/guide/cli.md @@ -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 diff --git a/docs/guide/quick-start.md b/docs/guide/quick-start.md index ea502c4..6f93f9e 100644 --- a/docs/guide/quick-start.md +++ b/docs/guide/quick-start.md @@ -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) diff --git a/package.json b/package.json index 6953c37..a24e23b 100644 --- a/package.json +++ b/package.json @@ -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": "zak@ubiquits.com", - "url": "http://twitter.com/zak" - }, + "author": "Zak Henry (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", @@ -53,6 +49,9 @@ "zone.js": "^0.6.12" }, "devDependencies": { - "@ubiquits/toolchain": "^0.0.12" + "@ubiquits/toolchain": "^0.1.0" + }, + "directories": { + "doc": "docs" } }