Skip to content

Commit

Permalink
update README for launch 🎉
Browse files Browse the repository at this point in the history
  • Loading branch information
jackmcdade committed Jul 17, 2018
1 parent 0f078c8 commit 2f85c56
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
# SEO Pro ![Statamic](https://img.shields.io/badge/statamic-2.10-blue.svg?style=flat-square)
> An SEO addon for Statamic professionals.
> SEO Pro is an all-in-one site reporting, metadata wrangling, Open Graph managing, Twitter card making, sitemap generating, turnkey addon.
## Documentation

Read it on the [Statamic Marketplace](https://statamic.com/markeplace/addons/seo-pro) or contribute to it [here on GitHub](DOCUMENTATION.md).
## SEO Pro is a Commercial Addon.

## Requirements
You can use it for free while in development, but requires a license to use on a live site. Learn more or buy a license on [The Statamic Marketplace](https://statamic.com/marketplace/addons/seo-pro)!

Statamic 2.10 is required for Control Panel usage.

## Developing
## Documentation

- Copy `.env.example` to `.env` and change `STATAMIC_PATH` to the path to your Statamic installation
- `npm install`
- `npm run watch` so any file changes get copied to your Statamic site
Read the docs on the [Statamic Marketplace](https://statamic.com/markeplace/addons/seo-pro/docs) or contribute to it [here on GitHub](DOCUMENTATION.md).

0 comments on commit 2f85c56

Please sign in to comment.