Skip to content

Commit

Permalink
📖 readme & changelog updates
Browse files Browse the repository at this point in the history
  • Loading branch information
acburdine committed Sep 26, 2016
1 parent 0db9899 commit 02436dc
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Ghost-CLI Changelog

## 1.0.0-alpha.2
- :sparkles: New `ghost install local` shortcut that offers a quick way to install locally for theme developers
- :bug: Ensure environment is used correctly when running `ghost start`
- :bug: Ensure `ghost update` maintains the currently running node environment
- :bug: Ensure lodash is required correctly on case-sensitive filesystems

## 1.0.0-alpha.1
- Initial Version
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
npm install -g ghost-cli
```

---

## Usage:

```sh
Expand All @@ -22,12 +24,20 @@ ghost <command>

#### NOTE: This CLI is not designed to work with any Ghost versions < 1.0.0

---

## Commands

#### `ghost install [version]`

Installs a particular version of Ghost. If no version is specified, the CLI will install the latest available version.

###### `ghost install local`

Running `ghost install local` is a quick way to set up a development version of ghost on your local environment. This can be useful for theme/adapter development.

---

## Developers

*Note: you must have [Git](https://git-scm.com/) installed*
Expand Down

0 comments on commit 02436dc

Please sign in to comment.