Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
25959fd
commit a8b9737
Showing
3 changed files
with
112 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
=== Materializer WP === | ||
Author: Cody Reichert | ||
Contributors: Cody Reichert | ||
Tags: material design, google, material components, short-code, design, ui, material ui | ||
Requires at least: 3.0.1 | ||
Tested up to: 4.3.1 | ||
Stable tag: 0.2.0 | ||
License: GPLv3 | ||
License URI: http://www.gnu.org/licenses/gpl-3.0.html | ||
|
||
Materializer is a set of Material Design Components for WordPress. Powered by simple short-codes, Materializer includes everything you need to add Material Design to your site. | ||
|
||
== Description == | ||
|
||
= Getting Started = | ||
|
||
Thanks for installing! Let me show you around: | ||
|
||
**Documentation:** | ||
|
||
- All of the documentation can be found at [The documentation page](http://codyreichert.github.io/materializer) | ||
|
||
= Quickstart = | ||
|
||
Materializer comes with over 25 different Material Design components | ||
and hundreds of ways to customize them. To get a good idea of how it all | ||
works, add this short-code to your page after installing the plugin: | ||
|
||
|
||
> [card title="A Cool Card!" text="text-darken-3 grey" title_color="blue"] | ||
> I am a very simple card. I am good at containing mall bits of | ||
> information. I am convenient because I require little markup to use | ||
> effectively. | ||
> [link text="blue" to="/"]Go Home[/link] | ||
> [/card] | ||
|
||
|
||
The short-code above gives a material design *card*, of which you can | ||
control the title, background color, text color, and link color. This | ||
is just one of many ways you can use and combine short-codes. | ||
|
||
|
||
= Support and Bugs = | ||
|
||
If you have any question, can't get something to work, or notice a bug, please submit it on the | ||
[Materializer issue tracker](https://github.com/CodyReichert/materializer/issues). | ||
|
||
Pull requests to the Github Repo are also welcome! | ||
|
||
|
||
== Installation == | ||
|
||
You can install this plugin a couple of different ways: | ||
|
||
= Wordpress Plugin Directory = | ||
|
||
1. If you usually install plugins via the Wordpress Dashboard 'Add | ||
Plugins' page, you can just search for 'Materializer' and click | ||
install! | ||
|
||
= Install from the .zip: = | ||
|
||
1. Download the `.zip` file | ||
|
||
1. In your Wordpress dashboard, go to `Plugins -> Add New`. Choose `Upload a New Plugin` and upload the `.zip` file. | ||
|
||
= Manual install from .zip: = | ||
|
||
1. Download the `.zip` file and extract it into your sites `wp-content/plugins` directory | ||
|
||
1. Be sure to extract it into a directory called `wp-content/plugins/materializer/`. | ||
|
||
= Activating = | ||
|
||
Once you have the plugin installed via one of the methods above, you | ||
can go to the Plugins page of your Wordpress site and click `activate` | ||
on Materializer. Once successfully activated, you're good to go! | ||
|
||
|
||
== Screenshots == | ||
|
||
1. Basic Material Design card component | ||
|
||
2. A Material Design 'raised' button. | ||
|
||
3. Collapsible/Accoridion component. | ||
|
||
4. Dropdown menu (open) component. | ||
|
||
5. Circular and Responsive image component. | ||
|
||
6. Pagination component. | ||
|
||
7. Preloader (circular/flashing) component. | ||
|
||
8. Striped table component. | ||
|
||
|
||
== Changelog == | ||
|
||
= 0.2.0 = | ||
* FIX: Fix CSS namespace issue that created conflicts with other elements and styles on the page. | ||
|
||
= 0.1.0 = | ||
* Initial Release | ||
|
||
|
||
== Documentation == | ||
|
||
View the full documentation on the [Materializer Website](https://codyreichert.github.io/materializer) |