Skip to content
This repository has been archived by the owner on Aug 10, 2021. It is now read-only.

Commit

Permalink
Update docs to reflect current branch and repo.
Browse files Browse the repository at this point in the history
  • Loading branch information
futhr committed Dec 29, 2014
1 parent 3f9ccd9 commit 918755e
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 35 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,3 @@
# Changelog

#### 3.0.0.beta
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,30 @@
# Contributing

In the spirit of [free software][1], **everyone** is encouraged to help improve this project.

Here are some ways *you* can contribute:

* by using prerelease versions
* by reporting [bugs][2]
* by suggesting new features
* by writing translations
* by writing or editing documentation
* by writing specifications
* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
* by refactoring code
* by resolving [issues][2]
* by reviewing patches

Starting point:

* Fork the repo
* Clone your repo
* Run `bundle install`
* Run `bundle exec rake test_app` to create the test application in `spec/test_app`
* Make your changes
* Ensure specs pass by running `bundle exec rspec spec`
* Ensure all syntax ok by running `rubocop .`
* Submit your pull request

[1]: http://www.fsf.org/licensing/essays/free-sw.html
[2]: https://github.com/spree-contrib/spree_static_content/issues
2 changes: 1 addition & 1 deletion LICENSE.md
@@ -1,4 +1,4 @@
Copyright (c) 2014 Peter Berkenbosch and contributors.
Copyright (c) 2008-2015 Peter Berkenbosch and contributors.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
Expand Down
54 changes: 20 additions & 34 deletions README.md
@@ -1,14 +1,16 @@
# Spree Static Content

[![Build Status](https://api.travis-ci.org/spree/spree_static_content.png?branch=master)](https://travis-ci.org/spree/spree_static_content)
[![Code Climate](https://codeclimate.com/github/spree/spree_static_content.png)](https://codeclimate.com/github/spree/spree_static_content)
[![Build Status](https://travis-ci.org/spree-contrib/spree_static_content.svg?branch=master)](https://travis-ci.org/spree-contrib/spree_static_content)
[![Code Climate](https://codeclimate.com/github/spree-contrib/spree_static_content/badges/gpa.svg)](https://codeclimate.com/github/spree-contrib/spree_static_content)

Good, clean content management of pages for Spree. You can use this to:

- Add and manage static pages such as an 'About' page.
- Show a static page instead of existing dynamic pages such as the home page,
products pages, and taxon pages.

---

## HowTo

Using the 'Pages' option in the admin tab, you can add static pages to your Spree install. The page content can
Expand Down Expand Up @@ -40,55 +42,39 @@ position setting alters the order in which they appear.

Finally, toggle the visibility using the 'Visible' checkbox. If it is unchecked, the page will not be available.

---

## Basic Installation

Add to your `Gemfile`:

```ruby
gem 'spree_static_content', github: 'spree/spree_static_content', branch: 'master'
gem 'spree_static_content', github: 'spree-contrib/spree_static_content', branch: 'master'
```

Run:

bundle install
rails g spree_static_content:install
```sh
bundle && bundle exec rails g spree_static_content:install
```

That's all!

**NOTE: Check [Versionfile][1] for corresponding gem `branch` for your Spree version.**

## Contributing
---

In the spirit of [free software][2], **everyone** is encouraged to help improve this project.

Here are some ways *you* can contribute:

* by using prerelease versions
* by reporting [bugs][3]
* by suggesting new features
* by writing translations
* by writing or editing documentation
* by writing specifications
* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
* by refactoring code
* by resolving [issues][3]
* by reviewing patches
## Contributing

Starting point:
See corresponding [guidelines][2]

* Fork the repo
* Clone your repo
* Run `bundle install`
* Run `bundle exec rake test_app` to create the test application in `spec/test_app`
* Make your changes
* Ensure specs pass by running `bundle exec rspec spec`
* Submit your pull request
---

Copyright (c) 2014 [Peter Berkenbosch][4] and [contributors][5], released under the [New BSD License][6]
Copyright (c) 2008-2015 [Peter Berkenbosch][4] and [contributors][5], released under the [New BSD License][6]

[1]: https://github.com/spree/spree_static_content/blob/master/Versionfile
[2]: http://www.fsf.org/licensing/essays/free-sw.html
[3]: https://github.com/spree/spree_static_content/issues
[1]: https://github.com/spree-contrib/spree_static_content/blob/master/Versionfile
[2]: https://github.com/spree-contrib/spree_static_content/blob/master/CONTRIBUTING.md
[3]: https://github.com/spree-contrib/spree_static_content/issues
[4]: https://github.com/peterberkenbosch
[5]: https://github.com/spree/spree_static_content/graphs/contributors
[6]: https://github.com/spree/spree_static_content/blob/master/LICENSE.md
[5]: https://github.com/spree-contrib/spree_static_content/graphs/contributors
[6]: https://github.com/spree-contrib/spree_static_content/blob/master/LICENSE.md

0 comments on commit 918755e

Please sign in to comment.