Commit Graph

143 Commits

Author SHA1 Message Date
John O'Nolan
923f982fce Update readme
Spacing adjustments
2017-07-31 09:50:45 +04:00
John O'Nolan
2a9f8e0906 Updated readme
New screenshot + link to trademark policy
2017-07-31 09:49:24 +04:00
Hannah Wolfe
300465ffec 📖 Update docs links
Our documentation has had an overhaul, and some of the URLs have changed. This updates the links to be correct according to the latest version of the docs.
2017-07-26 23:27:23 +04:00
kirrg001
99d7cdf0ab 🔥 remove flux warning
no issue

- 1.0.0-rc.1 was released
- check it out https://dev.ghost.org/ghost-1-0-0-rc-1/
2017-07-11 20:25:09 +02:00
Katharina Irrgang
1813d1815d recommend node v6 (#8674)
no issue

- see https://docs.ghost.org/docs/supported-node-versions
- add supported node versions link to README
- run coverage for node v6
2017-07-11 14:05:38 +01:00
Kevin Ansfield
1a58a4757c 📖 update readme links
refs #8558
- updates broken links so they go to relevant pages that will soon have correct content
2017-06-08 20:45:16 +01:00
Kevin Ansfield
0f82e49159 📖 1.0.0 update for README.md and CONTRIBUTING.md (#8539)
refs #7421
- simplify README.md to be more use-case oriented and point to https://docs.ghost.org where appropriate
- remove majority of CONTRIBUTING.md content as it now lives at https://docs.ghost.org/contributing
- update adapter guide links in `content/adapters/README.md`
2017-06-08 17:05:27 +01:00
Katharina Irrgang
47b24b2d4f 🎨 Using yarn instead of npm according to the paragraph above it (#8475)
no issue
- original PR: https://github.com/TryGhost/Ghost/pull/8288
2017-05-23 17:24:24 +01:00
Katharina Irrgang
2b27cf69dc 🎨 add min version of yarn to our readme (#8452)
no issue
- earlier versions of yarn result in slightly different yarn.lock files that can cause issues with modified files when running `grunt master` and similar
2017-05-12 08:53:53 +01:00
Hannah Wolfe
e9a537004b Added pre-commit hook to handle submodules (#8302)
refs #8235

Usage:
- for existing development setups: `grunt symlink` (will create the pre-commit symlink)
- for fresh development setups: `npm run init` (symlinking happens as part of the typical set up)

-  Added pre-commit hook to handle submodules
  - Checks to see if there are any submodules about to be committed
  - Output matches closely to `git st` to make it easy to read
  - Requires interaction from the committer to accept that this really should be committed
-  Use grunt symlink to register githooks
  - Grunt symlink will make a link to the pre-commit hook
  - It ONLY does this if there isn't already a pre-commit hook, so won't overwrite anything
  - It does this as part of npm run init, not grunt init, because a release repo would NEVER want this
  - This is a dev tool, that configures the repo for development
2017-04-13 08:26:48 +01:00
Kevin Ansfield
1cb1ea105c 🛠 switch to using yarn in our Grunt tasks (#8261)
no issue

- use `yarn install` instead of `npm install` in grunt tasks
- remove `grunt deps` and `grunt shell:{shrinkwrap/prune/dedupe}` tasks as they are not needed when using `yarn`
- set `options.npmPath` to `yarn` for subgrunt so it doesn't use `npm install` automatically
- don't remove client contributors files in `grunt clean` - those files are now manually created and should be kept

* 🛠 switch to using yarn in our Grunt tasks
* 🛠 use yarn for `npm run init`, update README
2017-04-04 11:47:12 +01:00
Katharina Irrgang
76fd1264a8 📖 Update README installation instructions (#8175)
- add contributing workflow link already
- i would suggest we merge this PR if the workflow guide was reviewed
2017-03-23 16:02:21 +00:00
Katharina Irrgang
f4a68a2e52 🔥 remove gulp (#8159)
* remove gulpfile
* remove gulp dependencies
* Update README.md
2017-03-14 14:20:53 +00:00
Hannah Wolfe
ffcf7d1d83 Update install instructions to include global deps
- knex-migrator and gulp are required
2017-02-22 12:45:28 +00:00
David Balderston
a64b8f0449 Update Install Instructions (#8034)
No Issue

* You may have had a reason for it to be the way it was, but this
updates it to be the actual commands rather than just close to actual
commands
2017-02-22 07:21:54 +00:00
John O'Nolan
952fac6be4 Update alpha install instructions 2017-02-15 22:02:56 +07:00
Katharina Irrgang
12c0ca3d2f 🔥 remove knex-migrator from README (#7884)
no issue

- we will update the instructions for 1.0 before we release 1.0
2017-01-24 18:30:22 +01:00
John O'Nolan
56f30e9e0d 2017 (#7819)
* Dat copyright
* bro do u even 2017
2017-01-04 10:05:57 +00:00
Katharina Irrgang
8d8d7bdb26 knex migrator (#7565)
refs #7489
- remove sephiroth
- use knex migrator npm
- goodbye bootup script
- 🎨  update README
- 🎨  knex migrator @ 0.0.2
2016-10-17 13:50:29 +01:00
John O'Nolan
fa07cc7f52 Update readme for 1.0 😱 (#7405) 2016-09-20 15:59:34 +01:00
kirrg001
6275fdbb25 🔥 remove node 0.10 support, add node 6 support
refs #6899, refs #7098
2016-09-20 15:59:34 +01:00
Hannah Wolfe
ee1f4fdbdd Recommend Node v4 & use as default (#7102)
refs #7098

- Use Node.js v4 as our default build environment
- Add Node.js v6 as an allowed failure
- Update contributor guidelines and readme
- Fix issue with branch exceptions
2016-07-15 12:36:15 -06:00
Hannah Wolfe
8b53308f10 Update location of download page
- https://ghost.org/downloads/ is now https://ghost.org/developers/
2016-04-13 19:49:07 +01:00
Jeremiah Hoyet
979ca4039d Fixes README.md link to CONTRIBUTING.md 2016-02-20 08:25:20 -05:00
Hannah Wolfe
d593425147 README: supported node version info update 2016-02-12 11:39:13 +00:00
Naoya Kanai
4834cb436d Support Node v4 LTS semver-minor releases
Fixes #6473
- Replace Node v4.2 with v4 in Travis config
- Replace ~4.2.0 with ^4.2.0 in engines to support semver-minor bumps in LTS line
2016-02-12 01:37:27 +09:00
John O'Nolan
dfb45761b8 Update copyright year 2016-01-03 15:01:56 +02:00
Sean Hussey
39b7b3101f Fixing a small typo in the README. 2015-12-23 15:36:44 -05:00
Hannah Wolfe
8dbef11bc5 Updated node version text in README.md
no issue

- update README to match the new version support
2015-12-01 14:09:16 +08:00
John O'Nolan
1add453733 Remove forum mentions 2015-09-29 13:10:04 +02:00
Rafael Corrêa Gomes
69ba0922b2 Correct bold string 2015-08-27 20:48:15 -03:00
John O'Nolan
344bcfa693 Update readme with Slack support info
I'm not convinced this is going to work, but it's an attempt to get more people asking install questions in Slack rather than opening github issues. Also fix broken link to Ghost(Pro) further down, Github stripped the HTML so converted to Markdown.
2015-07-01 09:42:36 +02:00
John O'Nolan
832084f66f Add DigitalOcean infrastructure details 2015-06-16 10:50:06 +01:00
John O'Nolan
3e67014c23 Added new Slack team details
BECAUSE INTERNET
2015-04-15 14:59:25 +03:00
Hannah Wolfe
e5ed9c6fed Re-add #getting-started anchor
Install errors (from not building files) point here.
2015-03-19 12:52:48 +00:00
JonathanKryza
a4109f3edf Fixed broked Support link
Changed ghost.org/support to http://support.ghost.org/.

Thanks to http://derecho.elijah.cs.cmu.edu:8585/@top for finding the broken link.
2015-03-13 14:07:00 -05:00
John O'Nolan
29baee24ab Readmeeeeee 2015-03-13 14:03:40 +02:00
Hannah Wolfe
338e52f70a README & CONTRIBUTING updates
- update compatibility info
- better information on releases
- add ideas.ghost.org to feature request section of contrib
2015-03-09 20:54:00 +00:00
Hannah Wolfe
8553644760 Add compatibility notice to README 2015-02-28 16:46:16 +00:00
Jimmy Hsu
0c429c3aee Minor grammatical fixes to README.md
Added an Oxford comma for consistency, and clarified a slightly awkward sentence.
2015-02-14 17:09:14 -08:00
John O'Nolan
bd1211da5d Update copyright 2015-01-02 16:11:13 +02:00
John O'Nolan
e62ce6c5cb Removed double link, moved contributing ref.
- Contributing ref link was being gratuitously double-linked to, nixed that.
- Changed grammar which is ambiguous between US/UK colloquialism.
- Moved contributing/troubleshooting reference to "installing from git" heading rather than "quickstart" subheading
- Standardised 2-linebreaks between Markdown headings
2014-12-29 17:48:06 +02:00
Jason Williams
3a29393163 Revert punctuation change in README.md 2014-12-29 09:41:17 -06:00
Jason Williams
344f383dda Update README.md 2014-12-29 09:31:13 -06:00
Daniel Tsui
8e833cb024 readme.md edit
-missing comma
-use of "a" preceding an acronym with phonetic vowel
2014-12-29 03:21:52 -08:00
John O'Nolan
00e5f9a340 Added screenshot to readme 2014-10-29 17:34:00 +02:00
Hannah Wolfe
f71e7b908f Update README.md
Added a link to dev.ghost.org
2014-09-25 16:12:09 +01:00
Hannah Wolfe
b27db7b657 Updating README with clearer install paths 2014-09-24 22:05:37 +01:00
Hannah Wolfe
988ca127b6 Updating docs links to point to support.ghost.org 2014-08-10 23:17:40 +01:00
Nicola Mustone
adecd28465 Wrong Facebook page URL 2014-07-24 11:23:59 +02:00
John O'Nolan
ec05677737 Convert support links from forum to new support site 2014-06-12 12:52:01 +02:00
David Blurton
5c22de51d8 Fix link 2014-05-07 20:23:15 +01:00
Luke Shiels
dbd3061a4c Made better-er 2014-04-22 00:40:16 +01:00
Dmitry Mazuro
9aa25ad723 Use SVG version of travis build status badge 2014-04-06 19:45:13 +03:00
Hannah Wolfe
4afba3808b Update README & Contributing with details of stable branch 2014-04-01 00:22:04 +01:00
Hannah Wolfe
1102617768 Update README.md 2014-03-20 11:53:23 +00:00
John O'Nolan
b605f8b75a Update copyright 2014-03-13 22:43:05 +01:00
John O'Nolan
fb917c8baa ReadMe Improvements
SEMANTICS ALL UP IN THIS WHAT
2014-02-26 22:19:32 +01:00
Kenny Meyer
9b469e0336 Un-break Markdown syntax
Remove a superfluous "*" in the README
2014-02-19 01:03:17 -08:00
Harry Wolff
a4933fe432 Add link to README.md file about using ghost as
a npm module

fixes #2008
2014-02-09 11:17:49 -05:00
John O'Nolan
5f409b2fc3 We’re not really in alpha any more 2014-02-06 23:25:40 +07:00
John O'Nolan
2506ca1205 2013 => 2014 2014-01-13 01:31:58 +01:00
Hannah Wolfe
dd406cd6e7 Moved getting involved section 2013-11-12 09:05:57 +00:00
Hannah Wolfe
ece33a2d66 Clarifying getting started instructions 2013-11-12 08:52:44 +00:00
Zlatan Vasović
fb8336100e Use less markup for links 2013-10-22 21:22:35 +01:00
Hannah Wolfe
f085be4128 Readme update re password reset 2013-10-18 16:55:01 +01:00
Luke Arduini
1749b8f90a clarify ENOENT on npm install for new users 2013-10-16 16:17:32 -07:00
Hannah Wolfe
2dfadcbbcd README and CONTRIBUTING docs updates
- removed note about ssh
- added links to docs and forum
- added note about grunt prod
- more troubleshooting tips
2013-10-16 15:55:54 +01:00
Hannah Wolfe
581d0c6e11 Switching Travis button from private to public 2013-10-15 10:29:06 +01:00
moritz haarmann
10fa96a3d1 Update README.md
Small typo in Readme fixed
2013-10-14 14:24:33 +02:00
Hannah Wolfe
ea9c50f49e Minor updates to Readme 2013-09-18 23:30:45 +01:00
John O'Nolan
201e57cba1 Updating readme for launch 2013-09-18 01:53:00 +01:00
Hannah Wolfe
f78ea7356f Updated README.md and CONTRIBUTING.md
- improving installation / setup instructions and adding more detail about grunt tasks
2013-08-29 12:12:04 +01:00
John O'Nolan
56bb89e33f Updated ReadMe.md + added new Contributing.md 2013-08-19 16:08:43 +02:00
Hannah Wolfe
1ad70356b7 Adding contributor guide to readme 2013-08-08 16:45:32 +01:00
Hannah Wolfe
029e0b6e3b README updates - versions & grunt
- removed version from top of file as it was confusing
- updated versioning notes
- updated contributing notes to include installing grunt-cli globally
2013-07-31 09:10:10 +01:00
ErisDS
d57cea17f1 Milestone 0.2.0 version bump & updated Casper reference to match 2013-07-12 00:13:20 +01:00
ErisDS
51d75aec9b Docs and tests - closes #235
- fixed the test that the fixture change broke (sort of). We should be using separate fixtures for tests really, unless we want to test something about a Ghost install.
- updated readme with better docs
2013-07-11 23:42:50 +01:00
Hannah Wolfe
3d2b56b6a9 Config and naming
- issue #154, issue #224 and issue #220
- change port number from 3333 to 2368
- change main file name from app.js to index.js
- update README & package.json to match
2013-07-07 16:50:50 +01:00
John O'Nolan
329e3a661b Updating readme 2013-06-25 08:18:46 +02:00
Hannah Wolfe
bc3b8541ab Milestone 0.1.1 version bump commit & updated Casper reference to match 2013-06-18 22:42:30 +01:00
John O'Nolan
ce6ea8cd66 Updating readme to be more targeted at 0.2 developer access 2013-06-18 11:01:04 +02:00
Hannah Wolfe
1369789aec closes #150 - Updating Grunt
Grunt tasks are now hopefully a little bit less confusing
Have updated the readme to match
2013-06-15 19:33:52 +01:00
John O'Nolan
1ae2d0e192 Adding proper copyright info for Ghost Foundation 2013-06-02 09:10:11 +02:00
John O'Nolan
511df8fde4 Revert version to 0.1.0 to reflect accurate version in package.json - removed changelog (Github is our changelog). /cc @javorszky 2013-05-29 16:35:54 +02:00
John O'Nolan
5c475f9040 Updating contributors link to give more obvious credit to people who are writing code for Ghost. Fixing ugly linebreak with love. 2013-05-29 12:15:46 +02:00
Gabor Javorszky
d002ad4444 added readme explanations 2013-05-25 15:23:53 +01:00
Gabor Javorszky
6f87ecc3ee added readme explanations 2013-05-25 15:22:53 +01:00
John O'Nolan
eaecf4b252 Fixing some oopsies 2013-05-19 16:44:47 +01:00
John O'Nolan
c4a0389914 Updating README 2013-05-19 16:37:45 +01:00
Hannah Wolfe
5a00a5bc25 Adding the much coveted Travis-ci build badge 2013-05-13 21:46:49 +01:00
Hannah Wolfe
17d421bfcc Initial commit to GitHub repo 2013-05-11 17:44:25 +01:00
John O'Nolan
2f8ab3730e Initial commit 2013-05-04 04:09:13 -07:00