README.md in parklife-0.4.0 vs README.md in parklife-0.5.0

- old
+ new

@@ -2,18 +2,24 @@ [![GitHub Actions status](https://github.com/benpickles/parklife/workflows/Tests/badge.svg)](https://github.com/benpickles/parklife) [Parklife](https://github.com/benpickles/parklife) is a Ruby library to render a Rack app (Rails/Sinatra/etc) to a static site so it can be served by [Netlify](https://www.netlify.com), [Now](https://zeit.co/now), [GitHub Pages](https://pages.github.com), S3, or another static server. -## Installation +## Getting started Add Parklife to your application's Gemfile and run bundle install. ```ruby gem 'parklife' ``` +Now generate a Parkfile configuration file and build script. Include some Rails- or Sinatra-specific settings by passing `--rails` or `--sinatra`, create a GitHub Actions workflow to generate your Parklife build and push it to GitHub Pages by passing `--github-pages`. + +``` +$ bundle exec parklife init +``` + ## How to use Parklife with Rails Parklife is configured with a file called `Parkfile` in the root of your project, here's an example `Parkfile` for an imaginary Rails app: ```ruby @@ -43,13 +49,13 @@ Listing the routes included in the above Parklife application with `parklife routes` would output the following: ``` $ bundle exec parklife routes -/ crawl=true +/ crawl=true /feed.atom /sitemap.xml -/easter_egg crawl=true +/easter_egg crawl=true /404.html ``` Now you can run `parklife build` which will fetch all the routes and save them to the `build` directory ready to be served as a static site. Inspecting the build directory might look like this: