Skip to content

Commit

Permalink
📖 Update README.md (#8527)
Browse files Browse the repository at this point in the history
refs #7421
- update to match 1.0 readme style, all docs now live on https://docs.ghost.org so that we have a central place to update and accept suggestions
  • Loading branch information
kirrg001 authored and kevinansfield committed Jun 12, 2017
1 parent 906268d commit 0a49df8
Showing 1 changed file with 26 additions and 70 deletions.
96 changes: 26 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,102 +9,58 @@ The project is maintained by a non-profit organisation called the **Ghost Founda

- [Ghost.org](https://ghost.org)
- [Latest Release](https://ghost.org/developers/)
- [Support](http://support.ghost.org/)
- [Theme Docs](http://themes.ghost.org)
- [Contributing Guide](https://github.com/TryGhost/Ghost/blob/master/.github/CONTRIBUTING.md)
- [Help & Support](http://help.ghost.org/)
- [Theme Docs](http://themes.ghost.org/v0.11.9/)
- [API Docs](https://api.ghost.org/v0.11.9/)
- [Contributing Guide](https://docs.ghost.org/v0.11.9/docs/contributing)
- [Feature Requests](http://ideas.ghost.org/)
- [Dev Blog](http://dev.ghost.org)
- [Developer Blog](http://dev.ghost.org)
- [Self-hoster Docs](http://docs.ghost.org/v0.11.9/)

**NOTE: If you’re stuck, can’t get something working or need some help, please head on over and join our [Slack community](https://ghost.org/slack/) rather than opening an issue.**

# Important: Node.js version support

# Quick Start Install
See [Supported Node.js versions](https://docs.ghost.org/v0.11.9/docs/supported-node-versions)

Make sure you've installed Node.js - We recommend the latest **Node v4 LTS** release. For other versions [click here](http://support.ghost.org/supported-node-versions/). May contain nuts.

1. Download the [latest release](https://ghost.org/developers/) of Ghost
1. Unzip in the location you want to install
1. Fire up a terminal
1. `npm install --production`
1. Start Ghost!
- Local environment: `npm start`
- On a server: `npm start --production`
1. `http://localhost:2368/ghost` :tada:
# Hosting a live Ghost site

More [install docs](http://support.ghost.org/installation/) here in case you got stuck.
<a href="https://ghost.org/pricing"><img src="https://cloud.githubusercontent.com/assets/120485/18662071/f30da886-7f18-11e6-90f2-42c0ade79fd1.png" alt="Ghost(Pro)" /></a>

<a name="getting-started"></a>
# Developer Install (from git)
The easiest way to deploy Ghost is with our official **[Ghost(Pro)](https://ghost.org/pricing/)** managed service. You can have a fresh instance up and running in a couple of clicks with a worldwide CDN, backups, security and maintenance all done for you.

Install Node.js. (See [Supported Node.js versions](http://support.ghost.org/supported-node-versions/))
Not only will it save you [many hours per month](https://ghost.org/pricing/#why-ghost-pro), but all revenue goes to the Ghost Foundation, which funds the maintenance and further development of Ghost itself. So you’ll be supporting open source software *and* getting a great service **at the same time**! Talk about win/win. :trophy:

```bash
# Node v4.2+ LTS - recommended
# Node v0.10.x and v0.12.x - supported
#
# Choose wisely
```
# Self-Hosters

Clone :ghost:
Other options are also available if you prefer playing around with servers by yourself, of course. The freedom of choice is in your hands.

```bash
git clone git://github.com/tryghost/ghost.git
cd ghost
```
- [Self-hosting Guide](https://docs.ghost.org/v0.11.9/docs/getting-started-guide)

Install grunt. No prizes here.

```bash
npm install -g grunt-cli
```
# Theme Developers

Install Ghost. If you're running locally, use [master](https://github.com/TryGhost/Ghost/tree/master). For production, use [stable](https://github.com/TryGhost/Ghost/tree/stable). :no_entry_sign::rocket::microscope:
If you are developing a Ghost theme for your own site or creating themes for others to use we recommend installing Ghost on your own local machine. Luckily we have a brand new Ghost CLI to make this really easy 😄

```bash
npm install
```
- [Installing Ghost via the CLI](https://docs.ghost.org/v0.11.9/docs/installing-ghost-via-the-cli)
- [Theme Developer Docs](http://themes.ghost.org/v0.11.9)

Build the things!

```bash
grunt init
```
# Contributors & Advanced Developers

Minify that shit for production?
For anyone wishing to contribute to Ghost or to hack/customise core files we recommend following our development setup guides:

```bash
grunt prod
```

Start your engines.

```bash
npm start

## running production? Add --production
```

Congrats! You made it. BTW you can also just `npm install ghost` if you're into that sort of thing. NPM aficionados can also read up on using [Ghost as an NPM module](https://github.com/TryGhost/Ghost/wiki/Using-Ghost-as-an-npm-module).

More general [install docs](http://support.ghost.org/installation/) here in case you got stuck.


# Deploying Ghost

![Ghost(Pro) + DigitalOcean](https://cloud.githubusercontent.com/assets/120485/8180331/d6674e32-1414-11e5-8ce4-2250e9994906.png)

Save yourself time and headaches with our fully managed **[Ghost(Pro)](https://ghost.org/pricing/)** service. Deploy a new instance of Ghost in a couple of clicks running on [DigitalOcean](https://digitalocean.com)’s rock solid infrastructure, with a worldwide CDN thrown in at no extra charge.

All revenue from **Ghost(Pro)** goes to the Ghost Foundation, the non-profit org which funds the maintenance and further development of Ghost.

[Other options](http://support.ghost.org/deploying-ghost/) are also available if you prefer playing around with servers by yourself.
- [General Contributor Guide](https://docs.ghost.org/v0.11.9/docs/contributing)
- [Developer Setup Instructions](https://docs.ghost.org/v0.11.9/docs/working-with-ghost)
- [Admin Client development guide](https://docs.ghost.org/v0.11.9/docs/working-with-the-admin-client)


# Staying Up to Date

When a new version of Ghost comes out, you'll want to look over these [upgrade instructions](http://support.ghost.org/how-to-upgrade/) for what to do next.
When a new version of Ghost comes out, you'll want to look over these [upgrade instructions](https://docs.ghost.org/v0.11.9/docs/how-to-upgrade-ghost) for what to do next.

You can talk to other Ghost users and developers in our [public Slack team](https://ghost.org/slack/) (it's pretty awesome). We have a public meeting every Tuesday at 5:30pm UK time.
You can talk to other Ghost users and developers in our [public Slack team](https://ghost.org/slack/) (it's pretty awesome).

New releases are announced on the [dev blog](http://dev.ghost.org/tag/releases/). You can subscribe by email or follow [@TryGhost_Dev](https://twitter.com/tryghost_dev) on Twitter, if you prefer your updates bite-sized and facetious.

Expand Down

0 comments on commit 0a49df8

Please sign in to comment.