README

Create side bar menu widgets

Requirements _{(Installed automatically when using Composer)}

• SilverStripe ^3.1
• Silverstripe Widgets ^1.0
• Display Logic ^1.0

Installation

Installation with Composer is the preferred method, as it will ensure you have all the required dependencies.

cd /your/project/folder
composer require gdmedia/silverstripe-widget-sidebar-nav

or
Ensure all requirements are installed and download the the zip. Extract and rename silverstripe-widget-sidebar-nav-master to silverstripe-widget-sidebar-nav

Once the files are installed, you must run dev/build and flush

http://youprojectdomain.nz/dev/build?flush=all

License

3-clause BSD license
See License

Documentation

• ToDo

Bugtracker

Bugs are tracked in the issues section of this repository. Before submitting an issue please read over existing issues to ensure yours is unique.

If the issue does look like a new bug:

• Create a new issue
• Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
• Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bug tracker.

Development and contribution

Feature requests can also be made by creating a new issue.
If you would like to make contributions to thhi module, feel free to create a fork and submit a pull request

Versioning

Prior to version 1.0.0 breaking changes may occur.

This project follows Semantic Versioning paradigm. That is:

Given a version number MAJOR.MINOR.PATCH, increment the:

1. MAJOR version when you make incompatible API changes,
2. MINOR version when you add functionality in a backwards-compatible manner, and
3. PATCH version when you make backwards-compatible bug fixes.
4. Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.