Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
estrattonbailey committed Jun 6, 2019
1 parent a73d6a4 commit eebd66d
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,33 @@
# Slater
Slater is a new toolkit for building and deploying themes on Shopify.
![repo-banner](https://user-images.githubusercontent.com/4732330/59070492-e925a900-8888-11e9-9dd5-90fb7b8da034.png)

```bash
npm i slater -g
```
<br />

A new toolkit for building and deploying themes on Shopify.

<br />

> This project is an active work in progress! The CLI is stable, but **the theme
> itself is not**.
> This project is an active work in progress!
>
> The CLI for compiling and uploading themes is stable, but **the starter theme
> needs some love!**
>
> Want to help? We'd love to have you. Ideas, feedback,
> critiques 👉 shoot us an Issue.
<br />

### Install
```bash
npm i slater -g
```

### Features
## Features
- asset pipeline via Webpack, Babel, PostCSS/SASS
- built-in deployment tool
- live reloading
- simple config
- easy integration into existing themes
- starter theme (WIP)

### Table of Contents
## Table of Contents
- [Quick Start](#quick-start)
- [Usage](#usage)
- [Themes](#themes)
Expand All @@ -45,8 +48,6 @@ npm i slater -g

<br>

![slater](https://media.giphy.com/media/129ndN2vLNGvbW/giphy.gif)

## Quick Start
The easist way to get started with Slater is `slater init`. `init` outputs a
default folder structure into the directory of your choice.
Expand Down

0 comments on commit eebd66d

Please sign in to comment.