Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chesterhow committed Jan 8, 2018
1 parent 04309a0 commit 26fe53f
Showing 1 changed file with 33 additions and 6 deletions.
39 changes: 33 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,55 @@ Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo [here
- Pagination of posts

## Installation

### As a Jekyll theme
1. Add this line to your `Gemfile`:

```ruby
gem "tale"
```

2. And add this line to your `_config.yml`:
2. In `_config.yml` replace the `minima` theme with `tale`:

```yaml
theme: tale
```
3. Install the theme's gems and dependencies:
$ bundle
```bash
$ bundle
```

4. Rename `index.md` to `index.html`. Without this, the `jekyll-paginate` gem will not work.

5. Add these 2 lines in to `_config.yml`:

```yaml
permalink: /:year-:month-:day/:title
paginate: 5
```
### As a Fork
1. Fork this repository
4. Finally, build and serve your site
2. Delete the unnecessary files/folders: `CODE_OF_CONDUCT.md`, `LICENSE`, `README.md`, `tale.gemspec`

$ bundle exec jekyll serve
3. Delete the `baseurl` line in `_config.yml`:

```yaml
baseurl: "/tale" # delete this line
```

## Usage
Once you've installed the theme, you're ready to work on your Jekyll site. To start off, I would recommend updating `_config.yml` with your site's details.

To build and serve your site, run:

```bash
$ bundle exec jekyll serve
```

Head to http://localhost:4000/tale/ to see your site in action.
And you're all set! Head over to http://127.0.0.1:4000/ to see your site in action.

## Contributing
Found a bug or have a suggestion? Feel free to create an issue or make a pull request!
Expand Down

0 comments on commit 26fe53f

Please sign in to comment.