change npm package name to desi, update docs
This commit is contained in:
parent
999dc3e320
commit
e7fbf19071
36
README.md
36
README.md
|
@ -10,19 +10,24 @@ Install and Usage
|
||||||
|
|
||||||
If you're on OS X or Linux, it's as easy as pie to install and use Desirae.
|
If you're on OS X or Linux, it's as easy as pie to install and use Desirae.
|
||||||
|
|
||||||
First install node.js, if you haven't already.
|
First install io.js (or node.js), if you haven't already.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install node.js/io.js v0.11.14+
|
# io.js
|
||||||
|
|
||||||
|
echo "v1.0.1" > /tmp/NODE_VER
|
||||||
|
curl -fsSL bit.ly/easy-install-iojs | bash
|
||||||
|
|
||||||
|
# node.js
|
||||||
|
|
||||||
echo "v0.11.14" > /tmp/NODE_VER
|
echo "v0.11.14" > /tmp/NODE_VER
|
||||||
curl -fsSL bit.ly/easy-install-node | bash
|
curl -fsSL bit.ly/easy-install-node | bash
|
||||||
```
|
```
|
||||||
|
|
||||||
Then install deardesi
|
Then install desi
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install -g deardesi
|
npm install -g desi
|
||||||
```
|
```
|
||||||
|
|
||||||
And create a copy of the desirae-seed
|
And create a copy of the desirae-seed
|
||||||
|
@ -38,19 +43,34 @@ git submodule update
|
||||||
And now fire up Dear Desi to get started
|
And now fire up Dear Desi to get started
|
||||||
|
|
||||||
```
|
```
|
||||||
deardesi ~/my-desirae-blog 65080
|
desi serve -b ~/my-desirae-blog
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Now open up your evergreen browser to <http://local.dear.desi:65080>
|
||||||
|
|
||||||
Once you've done the initial setup, you can run deardesi from the commandline
|
Commandline
|
||||||
|
===========
|
||||||
|
|
||||||
|
Once you've done the initial setup in the browser, you can run `desi` from the commandline
|
||||||
|
|
||||||
|
**NOTE:** You can omit the `-b` if you are already in your blog directory.
|
||||||
|
|
||||||
|
Build Production Site
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
You must set `base_path` and `base_url` in `site.yml` before attempting to build.
|
||||||
|
|
||||||
```
|
```
|
||||||
deardesi ~/my-desirae-blog ~/my-desirae-blog/compiled
|
desi build -b ~/my-desirae-blog
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Outputs to `~/my-desirae-blog/compiled`
|
||||||
|
|
||||||
Create a new Post
|
Create a new Post
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
```
|
```
|
||||||
deardesi post "My First Post"
|
desi post "My First Post" -b ~/my-desirae-blog
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Outputs to `~/my-desirae-blog/posts/my-first-post.md`
|
||||||
|
|
|
@ -7,7 +7,7 @@ var PromiseA = require('bluebird')
|
||||||
;
|
;
|
||||||
|
|
||||||
cli.parse({
|
cli.parse({
|
||||||
blog: ['b', 'Where your blog is, i.e. ~/path/to/blog', 'string', './']
|
blogdir: ['d', 'Where your blog is, i.e. ~/path/to/blog', 'string', './']
|
||||||
//, output: ['o', 'name of output directory within ~/path/to/blog', 'string', './compiled']
|
//, output: ['o', 'name of output directory within ~/path/to/blog', 'string', './compiled']
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
{
|
{
|
||||||
"name": "deardesi",
|
"name": "desi",
|
||||||
"version": "0.5.0",
|
"version": "0.5.0",
|
||||||
"description": "A nice, friendly tool to help you get set up and start blogging, built on the Desirae blogging platform",
|
"description": "A nice, friendly tool to help you get set up and start blogging, built on the Desirae blogging platform",
|
||||||
"main": "server.js",
|
"main": "server.js",
|
||||||
|
@ -8,6 +8,7 @@
|
||||||
},
|
},
|
||||||
"bin": {
|
"bin": {
|
||||||
"deardesi": "bin/deardesi.js"
|
"deardesi": "bin/deardesi.js"
|
||||||
|
, "desi": "bin/deardesi.js"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
|
@ -43,7 +44,7 @@
|
||||||
"connect": "^3.3.4",
|
"connect": "^3.3.4",
|
||||||
"connect-query": "^0.2.0",
|
"connect-query": "^0.2.0",
|
||||||
"connect-send-json": "^1.0.0",
|
"connect-send-json": "^1.0.0",
|
||||||
"desirae": "^0.9.0",
|
"desirae": "^0.9.1",
|
||||||
"fs.extra": "^1.3.0",
|
"fs.extra": "^1.3.0",
|
||||||
"require-yaml": "0.0.1",
|
"require-yaml": "0.0.1",
|
||||||
"serve-static": "^1.8.0"
|
"serve-static": "^1.8.0"
|
||||||
|
|
Loading…
Reference in New Issue