[![Codestar Framework](http://s3.codestarthemes.com/codecanyon/23079100/github-banner.png)](http://codestarframework.com/)

# Codestar Framework
A Simple and Lightweight WordPress Option Framework for Themes and Plugins. Built in Object Oriented Programming paradigm with high number of custom fields and tons of options. Allows you to bring custom admin, metabox, taxonomy and customize settings to all of your pages, posts and categories. It's highly modern and advanced framework.

## Contents
- [Demo](#demo)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Documentation](#documentation)
- [Free vs Premium](#free-vs-premium)
- [Support](#support)
- [Release Notes](#release-notes)
- [License](#license)

## Demo
For usage and examples, have a look at :rocket: [online demo](http://codestarthemes.com/plugins/codestar-framework/wp-login.php?login=demo)

## Installation

1. Download the installable WordPress plugin zip.
2. Upload and active plugin from `WordPress` &rarr; `Plugins` &rarr; `Add New`
3. After activation, next step is to configure your settings. You can do it from here :gear: [configurations](http://codestarframework.com/documentation/#/configurations)

## Quick Start

Open your current theme **functions.php** file and paste this code.

```php
// Check core class for avoid errors
if( class_exists( 'SCS' ) ) {

  // Set a unique slug-like ID
  $prefix = 'my_framework';

  // Create options
  SCS::createOptions( $prefix, array(
    'menu_title' => 'My Framework',
    'menu_slug'  => 'my-framework',
  ) );

  // Create a section
  SCS::createSection( $prefix, array(
    'title'  => 'Tab Title 1',
    'fields' => array(

      // A text field
      array(
        'id'    => 'opt-text',
        'type'  => 'text',
        'title' => 'Simple Text',
      ),

    )
  ) );

  // Create a section
  SCS::createSection( $prefix, array(
    'title'  => 'Tab Title 2',
    'fields' => array(

      // A textarea field
      array(
        'id'    => 'opt-textarea',
        'type'  => 'textarea',
        'title' => 'Simple Textarea',
      ),

    )
  ) );

}
```
How to get option value ?
```php
$options = get_option( 'my_framework' ); // unique id of the framework

echo $options['opt-text']; // id of the field
echo $options['opt-textarea']; // id of the field
```

## Documentation
Read the documentation for details :closed_book: [documentation](http://codestarframework.com/documentation/)

## Free vs Premium

| Features                     | Free Version       | Premium Version
|:-----------------------------|:------------------:|:-----------------:
| Admin Option Framework       | :heavy_check_mark: | :heavy_check_mark:
| Customize Option Framework   | :x:                | :heavy_check_mark:
| Metabox Option Framework     | :x:                | :heavy_check_mark:
| Nav Menu Option Framework    | :x:                | :heavy_check_mark:
| Taxonomy Option Framework    | :x:                | :heavy_check_mark:
| Profile Option Framework     | :x:                | :heavy_check_mark:
| Comment Option Framework     | :x:                | :heavy_check_mark:
| Widget Option Framework      | :x:                | :heavy_check_mark:
| Shortcode Option Framework   | :x:                | :heavy_check_mark:
| All Option Fields            | :x:                | :heavy_check_mark:
| Developer Packages           | :x:                | :heavy_check_mark:
| Unminfy Library              | :x:                | :heavy_check_mark:
| New Requests                 | :x:                | :heavy_check_mark:
| Autoremove Advertisements    | :x:                | :heavy_check_mark:
| Life-time access/updates     | :x:                | :heavy_check_mark:
|                              |                    | :star2: <a href="http://codestarframework.com/">Upgrade Premium Version</a>

## Available Option Fields

| Accordion   | Color       | Icon         | Select   | Tabbed
|:------------|:------------|:-------------|:---------|:---
| Background  | Color Group | Image Select | Slider   | Text
| Backup      | Date        | Link Color   | Sortable | Textarea
| Border      | Dimensions  | Media        | Sorter   | Typography
| Button Set  | Fieldset    | Palette      | Spacing  | Upload
| Checkbox    | Gallery     | Radio        | Spinner  | WP Editor
| Code Editor | Group       | Repeater     | Switcher | Others

## Support

We are provide [support forum](http://support.codestarthemes.com/) for premium version users. You can join to support forum for submit any question after purchasing. Free version users support is limited on [github](https://github.com/Codestar/codestar-framework/issues).

## Release Notes
Check out the [release notes](http://codestarframework.com/documentation/#/relnotes)

## License
Codestar Framework have two different version. Free version has limited features and offers only admin option panel feature. Premium version offers all extensions and more of settings for the best experience and advanced features. You can bundle the framework ( both free and premium ) in your free theme/plugin that you publish inside WordPress.org theme/plugin directory or in premium theme/plugin that you sell on your own website or in marketplaces like ThemeForest. This framework is licensed 100% GPL.
