# Read Me

Alchemy Options is an options plugin for WordPress, simple but powerful. Inspired by [OptionTree](https://wordpress.org/plugins/option-tree/) and [Archetype](https://github.com/kgiszewski/Archetype).

## Features

* Multiple [WYSIWYG editors](https://docs.alchemy-options.com/fields/editor) (including dynamic creation in a [Repeater](https://docs.alchemy-options.com/fields/repeater) field)
* Multisite compatible with [network options](https://docs.alchemy-options.com/samples#network-options) stored on the Network admin page
* Can be used in [Meta Boxes](https://docs.alchemy-options.com/meta-boxes)
* [Field groups](https://docs.alchemy-options.com/fields/field-group) and [Sections](https://docs.alchemy-options.com/fields/sections)
* [Repeater](https://docs.alchemy-options.com/fields/repeater) fields can be [nested](https://docs.alchemy-options.com/fields/repeater#nested-repeaters) and allow adding repeatees of [different types](https://docs.alchemy-options.com/fields/repeater#typed-repeaters).
* [Dynamic filter](https://docs.alchemy-options.com/broken-reference) for each option before returning its value
* [Client-side helpers](https://docs.alchemy-options.com/javascript)
* Translation ready

## Current [field types](https://docs.alchemy-options.com/fields)

* [Text](https://docs.alchemy-options.com/fields/text)
* [Password](https://docs.alchemy-options.com/fields/password)
* [URL](https://docs.alchemy-options.com/fields/url)
* [Email](https://docs.alchemy-options.com/fields/email)
* [Tel](https://docs.alchemy-options.com/fields/tel)
* [Textarea](https://docs.alchemy-options.com/fields/textarea)
* [Textblock](https://github.com/AlchemyOptions/docs/tree/abcc2b50754c19cf92e29b27f23f6e6a54d1ffa1/fields/textblock.md)
* [Editor (WYSIWYG)](https://docs.alchemy-options.com/fields/editor)
* [Datepicker](https://docs.alchemy-options.com/fields/datepicker)
* [Upload](https://docs.alchemy-options.com/fields/upload)
* [Radio](https://docs.alchemy-options.com/fields/radio)
* [Select](https://docs.alchemy-options.com/fields/select)
* [Checkbox](https://docs.alchemy-options.com/fields/checkbox)
* [Checkbox image](https://docs.alchemy-options.com/fields/image-radio)
* [Colorpicker](https://docs.alchemy-options.com/fields/colorpicker)
* [Image radio](https://docs.alchemy-options.com/fields/image-radio)
* [Post type select (single and multiple)](https://docs.alchemy-options.com/fields/post-type-select)
* [Datalist](https://docs.alchemy-options.com/fields/datalist)
* [Sections](https://docs.alchemy-options.com/fields/sections)
* [Repeater](https://docs.alchemy-options.com/fields/repeater)
* [Button group](https://docs.alchemy-options.com/fields/button-group)
* [Slider](https://docs.alchemy-options.com/fields/slider)
* [Tokens](https://github.com/AlchemyOptions/docs/tree/abcc2b50754c19cf92e29b27f23f6e6a54d1ffa1/fields/tokens.md)
* [Taxonomy select (single and multiple)](https://docs.alchemy-options.com/fields/taxonomy-select)
* [Field group](https://docs.alchemy-options.com/fields/field-group)

## Contribution

If you feel like Alchemy Options could be extended, or you think you've found a bug (most likely) please [create an issue on GitHub](https://github.com/AlchemyOptions/AlchemyOptions).

## Ready to go?

Please proceed to the [installation instructions](https://docs.alchemy-options.com/installation) or take a look at [configuration object examples](https://docs.alchemy-options.com/samples) to get you rolling.
