README

WooCommerce Product Filter (WOOF) extension to display set of filters depending on current product category page.

The WordPress Plugin WOOF by Category includes the following files:

.gitignore. Used to exclude certain files from the repository.
CHANGELOG.md. The list of changes to the core project.
README.md. The file that you’re currently reading.
A plugin-name directory that contains the source code - a fully executable WordPress plugin.

Features

The WOOF by Category is based on the Plugin API, Coding Standards, and Documentation Standards.
All classes, functions, and variables are documented so that you know what you need to be changed.
The WOOF by Category uses a strict file organization scheme that correspond both to the WordPress Plugin Repository structure, and that make it easy to organize the files that compose the plugin.
The project includes a .pot file as a starting point for internationalization.

Installation

git clone https://github.com/kagg-design/woof-by-category
cd woof-by-category
make install

Recommended Tools

i18n Tools

The WordPress Plugin WOOF by Category uses a variable to store the text domain used when internationalizing strings throughout the WOOF by Category. To take advantage of this method, there are tools that are recommended for providing correct, translatable files:

Any of the above tools should provide you with the proper tooling to internationalize the plugin.

License

The WordPress Plugin WOOF by Category is licensed under the GPL v2 or later.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

A copy of the license is included in the root of the plugin’s directory. The file is named LICENSE.

Important Notes

Licensing

The WordPress Plugin WOOF by Category is licensed under the GPL v2 or later; however, if you opt to use third-party code that is not compatible with v2, then you may need to switch to using code that is GPL v3 compatible.

For reference, here's a discussion that covers the Apache 2.0 License used by Bootstrap.

Credits

The current version of the WOOF by Category was developed by KAGG Design.

Documentation, FAQs, and More

If you’re interested in writing any documentation or creating tutorials please let me know.

kagg-design / woof-by-category

Maintainers

Details