From fa07cc7f522da5dacd42c1972f7a263726ebbc79 Mon Sep 17 00:00:00 2001 From: John O'Nolan Date: Tue, 20 Sep 2016 11:27:48 +0200 Subject: [PATCH] =?UTF-8?q?Update=20readme=20for=201.0=20=F0=9F=98=B1=20(#?= =?UTF-8?q?7405)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 66 +++++++++++++++++++++---------------------------------- 1 file changed, 25 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index aa79c868d3..e411339f6e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ -Ghost +Ghost Build status -![Ghost Screenshot](https://cloud.githubusercontent.com/assets/120485/6626466/6dae46b2-c8ff-11e4-8c7c-8dd63b215f7b.jpg) - -![Ghost is a simple, powerful publishing platform that allows you to share your stories with the world.](https://cloud.githubusercontent.com/assets/120485/6626501/b2bb072c-c8ff-11e4-8e1a-2e78e68fd5c3.png) +Warning: Major release in progress. Expect things to be broken in master. The project is maintained by a non-profit organisation called the **Ghost Foundation**, along with an amazing group of independent [contributors](https://github.com/TryGhost/Ghost/contributors). We're trying to make publishing software that changes the shape of online journalism. @@ -13,53 +11,45 @@ The project is maintained by a non-profit organisation called the **Ghost Founda - [Theme Docs](http://themes.ghost.org) - [Contributing Guide](https://github.com/TryGhost/Ghost/blob/master/.github/CONTRIBUTING.md) - [Feature Requests](http://ideas.ghost.org/) -- [Dev Blog](http://dev.ghost.org) +- [Developer Blog](http://dev.ghost.org) **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.** +  # Quick Start Install -Make sure you've installed Node.js - Latest **Node v4 LTS** release is required. We don't support 0.10.x anymore, see https://dev.ghost.org/end-of-node-js-0-10/. -For other versions [click here](http://support.ghost.org/supported-node-versions/). May contain nuts. +First, you’ll need **Node.js v4 LTS** or a [supported version](http://support.ghost.org/supported-node-versions/). 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. Unzip, and fire up terminal 1. `npm install --production` 1. Start Ghost! - Local environment: `npm start` - On a server: `npm start --production` 1. `http://localhost:2368/ghost` :tada: -More [install docs](http://support.ghost.org/installation/) here in case you got stuck. +More [install docs](http://support.ghost.org/installation/) here in case you get stuck. + +  -# Developer Install (from git) +# Developer Install -Install Node.js. (See [Supported Node.js versions](http://support.ghost.org/supported-node-versions/)) - -```bash -# Node v4.2+ LTS - recommended -# Node v6.5+ and v0.12.x - supported -# -# Choose wisely -``` - -Clone :ghost: +This is for if you want to hack on Ghost core. First, you’ll need **Node.js v4 LTS** or a [supported version](http://support.ghost.org/supported-node-versions/). Then: ```bash git clone git://github.com/tryghost/ghost.git cd ghost ``` -Install grunt. No prizes here. +Install grunt ```bash npm install -g grunt-cli ``` -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: +Install Ghost ```bash npm install @@ -71,34 +61,28 @@ Build the things! grunt init ``` -Minify that shit for production? +Start your engines ```bash -grunt prod +grunt dev ``` -Start your engines. +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. -```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) +Ghost(Pro) -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. +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. -All revenue from **Ghost(Pro)** goes to the Ghost Foundation, the non-profit org which funds the maintenance and further development of Ghost. +Not only will it save you [many hours per month](https://ghost.org/ghost-pro-vs-self-hosting/), 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: -[Other options](http://support.ghost.org/deploying-ghost/) are also available if you prefer playing around with servers by yourself. +[Other options](http://support.ghost.org/deploying-ghost/) are also available if you prefer playing around with servers by yourself, of course. The freedom of choice is in your hands. + +  # Staying Up to Date @@ -107,9 +91,9 @@ When a new version of Ghost comes out, you'll want to look over these [upgrade i 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. -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. +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. :saxophone::turtle: -:saxophone::turtle: +  # Copyright & License