Commit cb8e17ae authored by Arent-Jan Banck's avatar Arent-Jan Banck

HIPPLUG-1250 Add readme

parent 4dabedd5
# Selections Plugin
This is the Selections plugin for Hippo CMS. Documentation on how to use this
plugin in your Hippo project can be found at:
http://www.onehippo.org/library/concepts/plugins/selections/about.html
## Plugin Demo
A demo project is provided to see the plugin in action.
### Requirements
* Java 8 JDK
* Maven 3
### Download, Build and Run the Demo Project
1. Download the plugin's source code from https://code.onehippo.org/cms-community/hippo-plugin-selections
* Alternatively you can clone the git repository on your local machine.
* Use the latest stable branch named "release/x" (or "demo/x" in case the
demo is tagged seperately) where "x" is the version number.
* If you want to build the master branch demo you must configure the Hippo
Maven snapshot repository. See
http://www.onehippo.org/library/development/build-hippo-cms-from-scratch.html
for instructions.
2. Extract the archive on your local file system.
3. Use Maven to build and run the demo project:
```bash
cd hippo-plugin-selections/demo
mvn verify
mvn -P cargo.run
```
4. Hippo CMS will be available at http://localhost:8080/cms/ (login using
credentials `admin`/`admin`).
The demo website will be available at http://localhost:8080/site/.
### Development Branches
To build and run the demo from a development branch you may need to configure
access to the Hippo Maven snapshots repository. For more information see the
following documentation page:
http://www.onehippo.org/library/development/build-hippo-cms-from-scratch.html
......@@ -205,6 +205,7 @@
<inherited>false</inherited>
<configuration>
<excludes combine.children="append">
<exclude>README.md</exclude>
<!-- repository content XML -->
<exclude>addon-repository/src/main/resources/**/*.xml</exclude>
<exclude>demo/content/src/main/resources/**/*.xml</exclude>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment