Skip to content

Commit

Permalink
Updated readme files to include references to wordpress plugin directory
Browse files Browse the repository at this point in the history
  • Loading branch information
fatihbalsoy committed Dec 13, 2023
1 parent 33e9cd1 commit c7ee428
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 84 deletions.
50 changes: 7 additions & 43 deletions .readme/lang/README.base.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ WordPress için Material Board eklentisi, sitenizin gösterge panelinin görün
[![Demo](https://img.shields.io/badge/-Demo-446DFF?style=for-the-badge&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj48c3ZnIHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIHZpZXdCb3g9IjAgMCA0OCA0OCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4bWw6c3BhY2U9InByZXNlcnZlIiB4bWxuczpzZXJpZj0iaHR0cDovL3d3dy5zZXJpZi5jb20vIiBzdHlsZT0iZmlsbC1ydWxlOmV2ZW5vZGQ7Y2xpcC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjI7Ij48cGF0aCBkPSJNMTYsMzcuODVsMCwtMjhsMjIsMTRsLTIyLDE0Wm0zLC01LjQ1bDEzLjQ1LC04LjU1bC0xMy40NSwtOC41NWwwLDE3LjFaIiBzdHlsZT0iZmlsbDojZmZmO2ZpbGwtcnVsZTpub256ZXJvOyIvPjwvc3ZnPg==)](https://material-dashboard-demo.bal.soy/)

<!-- [common] -->
![WordPress](https://img.shields.io/badge/WordPress-6.3.1-lightblue?style=for-the-badge&logo=wordpress&logoWidth=20)
[![WordPress](https://img.shields.io/badge/WordPress-6.3.1-lightblue?style=for-the-badge&logo=wordpress&logoWidth=20)](https://wordpress.org/plugins/material-board/)
[![Build Status](https://img.shields.io/github/actions/workflow/status/fatihbalsoy/material-board/build.yml?style=for-the-badge&logo=github)](https://github.com/fatihbalsoy/material-board/actions/workflows/build.yml)

<!-- [en] -->
Expand Down Expand Up @@ -61,65 +61,29 @@ Bu belgeyi farklı bir dilde okuyun.
## Kurulum

<!-- [en] -->
### Manually

* Download the latest release of Material Board [here](https://github.com/fatihbalsoy/material-board/releases/),
* On your WordPress dashboard go to `Plugins` > `Add New`,
* Click the `Upload Plugin` button near the header,
* Select the downloaded zip archive,
* Finally, activate the Material Board plugin.
Material Board is available on the WordPress Plugin Directory [(link)](https://wordpress.org/plugins/material-board/) and can be installed from the plugins page in your admin dashboard.

<!-- [tr] -->
### El ile

* Material Board'ın en son sürümünü [buradan](https://github.com/fatihbalsoy/material-board/releases/) indirin,
* WordPress panonuzda `Eklentiler` > `Yeni Ekle` bölümüne gidin,
* Başlık yakınındaki `Eklenti Yükle` düğmesine tıklayın,
* İndirilen zip arşivini seçin,
* Son olarak, Material Board eklentisini etkinleştirin.
Material Board, WordPress Eklenti Dizini'nde mevcuttur [(link)](https://wordpress.org/plugins/material-board/) ve yönetici panonuzdaki eklentiler sayfasından yüklenebilir.

<!-- [en] -->
### WP Pusher (Automatic Updates)
### Manually

* Download the latest release of WP Pusher [here](https://wppusher.com/)
* Download the latest release of Material Board [here](https://github.com/fatihbalsoy/material-board/releases/),
* On your WordPress dashboard go to `Plugins` > `Add New`,
* Click the `Upload Plugin` button near the header,
* Select the downloaded zip archive,
* Activate the WP Pusher plugin,
* Go to `WP Pusher` > `Install Plugin`,
* Choose Github as the Repository Host,
* Input this repository's [link](fatihbalsoy/material-board) into `Plugin Repository`,
* Input the deployment branch, release-deployed, into `Repository Branch`,
* Click `Install Plugin`,
* Finally, activate the Material Board plugin.

<!-- [tr] -->
### WP Pusher (Otomatik Güncellemeler)
### El ile

* WP Pusher'ın en son sürümünü [buradan](https://wppusher.com/) indirin,
* Material Board'ın en son sürümünü [buradan](https://github.com/fatihbalsoy/material-board/releases/) indirin,
* WordPress panonuzda `Eklentiler` > `Yeni Ekle` bölümüne gidin,
* Başlık yakınındaki `Eklenti Yükle` düğmesine tıklayın,
* İndirilen zip arşivini seçin,
* WP Pusher eklentisini etkinleştirin,
* `WP Pusher` > `Install Plugin` bölümüne gidin,
* Github'ı Repository Host olarak seçin,
* Bu depo için [link](fatihbalsoy/material-board) adresini `Plugin Repository` alanına girin,
* `Repository Branch`'e release-deployed girin,
* `Install Plugin` düğmesine tıklayın,
* Son olarak, Material Board eklentisini etkinleştirin.

<!-- [en] -->
> ### ⚠️ NOTE
>
> This plugin is still in its pre-release phase and is not yet available on the WordPress Plugin Directory.
> Do not use WordPress' default updater to update the plugin. Disable Auto-Updates at the Plugins page.
<!-- [tr] -->
> ### ⚠️ NOT
>
> Bu eklenti hala ön yayın aşamasında olup, henüz WordPress Eklenti Dizini'nde mevcut değildir.
> WordPress'in varsayılan güncelleme mekanizmasını eklentiyi güncellemek için kullanmayın. Eklentiler sayfasında Otomatik Güncellemeler'i devre dışı bırakın.
<!-- [en] -->
## Customization

Expand Down
23 changes: 3 additions & 20 deletions .readme/lang/README.tr.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ WordPress için Material Board eklentisi, sitenizin gösterge panelinin görün
[![İndir](https://img.shields.io/badge/-İndir-2246CC?style=for-the-badge&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj48c3ZnIHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIHZpZXdCb3g9IjAgMCA0OCA0OCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4bWw6c3BhY2U9InByZXNlcnZlIiB4bWxuczpzZXJpZj0iaHR0cDovL3d3dy5zZXJpZi5jb20vIiBzdHlsZT0iZmlsbC1ydWxlOmV2ZW5vZGQ7Y2xpcC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjI7Ij48cGF0aCBkPSJNMTEsNDBjLTAuOCwwIC0xLjUsLTAuMyAtMi4xLC0wLjljLTAuNiwtMC42IC0wLjksLTEuMyAtMC45LC0yLjFsMCwtNy4xNWwzLC0wbDAsNy4xNWwyNiwwbDAsLTcuMTVsMywtMGwwLDcuMTVjMCwwLjggLTAuMywxLjUgLTAuOSwyLjFjLTAuNiwwLjYgLTEuMywwLjkgLTIuMSwwLjlsLTI2LDBabTEzLC03LjY1bC05LjY1LC05LjY1bDIuMTUsLTIuMTVsNiw2bDAsLTE4LjU1bDMsLTBsMCwxOC41NWw2LC02bDIuMTUsMi4xNWwtOS42NSw5LjY1WiIgc3R5bGU9ImZpbGw6I2ZmZjtmaWxsLXJ1bGU6bm9uemVybzsiLz48L3N2Zz4=)](https://github.com/fatihbalsoy/material-board/releases/)
[![Demo](https://img.shields.io/badge/-Demo-446DFF?style=for-the-badge&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj48c3ZnIHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIHZpZXdCb3g9IjAgMCA0OCA0OCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4bWw6c3BhY2U9InByZXNlcnZlIiB4bWxuczpzZXJpZj0iaHR0cDovL3d3dy5zZXJpZi5jb20vIiBzdHlsZT0iZmlsbC1ydWxlOmV2ZW5vZGQ7Y2xpcC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjI7Ij48cGF0aCBkPSJNMTYsMzcuODVsMCwtMjhsMjIsMTRsLTIyLDE0Wm0zLC01LjQ1bDEzLjQ1LC04LjU1bC0xMy40NSwtOC41NWwwLDE3LjFaIiBzdHlsZT0iZmlsbDojZmZmO2ZpbGwtcnVsZTpub256ZXJvOyIvPjwvc3ZnPg==)](https://material-dashboard-demo.bal.soy/)

![WordPress](https://img.shields.io/badge/WordPress-6.3.1-lightblue?style=for-the-badge&logo=wordpress&logoWidth=20)
[![WordPress](https://img.shields.io/badge/WordPress-6.3.1-lightblue?style=for-the-badge&logo=wordpress&logoWidth=20)](https://wordpress.org/plugins/material-board/)
[![Build Status](https://img.shields.io/github/actions/workflow/status/fatihbalsoy/material-board/build.yml?style=for-the-badge&logo=github)](https://github.com/fatihbalsoy/material-board/actions/workflows/build.yml)

Bu belgeyi farklı bir dilde okuyun.
Expand All @@ -25,6 +25,8 @@ Bu belgeyi farklı bir dilde okuyun.

## Kurulum

Material Board, WordPress Eklenti Dizini'nde mevcuttur [(link)](https://wordpress.org/plugins/material-board/) ve yönetici panonuzdaki eklentiler sayfasından yüklenebilir.

### El ile

* Material Board'ın en son sürümünü [buradan](https://github.com/fatihbalsoy/material-board/releases/) indirin,
Expand All @@ -33,25 +35,6 @@ Bu belgeyi farklı bir dilde okuyun.
* İndirilen zip arşivini seçin,
* Son olarak, Material Board eklentisini etkinleştirin.

### WP Pusher (Otomatik Güncellemeler)

* WP Pusher'ın en son sürümünü [buradan](https://wppusher.com/) indirin,
* WordPress panonuzda `Eklentiler` > `Yeni Ekle` bölümüne gidin,
* Başlık yakınındaki `Eklenti Yükle` düğmesine tıklayın,
* İndirilen zip arşivini seçin,
* WP Pusher eklentisini etkinleştirin,
* `WP Pusher` > `Install Plugin` bölümüne gidin,
* Github'ı Repository Host olarak seçin,
* Bu depo için [link](fatihbalsoy/material-board) adresini `Plugin Repository` alanına girin,
* `Repository Branch`'e release-deployed girin,
* `Install Plugin` düğmesine tıklayın,
* Son olarak, Material Board eklentisini etkinleştirin.

> ### ⚠️ NOT
>
> Bu eklenti hala ön yayın aşamasında olup, henüz WordPress Eklenti Dizini'nde mevcut değildir.
> WordPress'in varsayılan güncelleme mekanizmasını eklentiyi güncellemek için kullanmayın. Eklentiler sayfasında Otomatik Güncellemeler'i devre dışı bırakın.
## Özelleştirme

Panonun renklerini ve görünümünü özelleştirmek için `Görünüm` > `Material Board` bölümüne gidin.
Expand Down
23 changes: 3 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Material Board plugin for WordPress updates the appearance of your site's da
[![Download](https://img.shields.io/badge/-Download-2246CC?style=for-the-badge&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj48c3ZnIHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIHZpZXdCb3g9IjAgMCA0OCA0OCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4bWw6c3BhY2U9InByZXNlcnZlIiB4bWxuczpzZXJpZj0iaHR0cDovL3d3dy5zZXJpZi5jb20vIiBzdHlsZT0iZmlsbC1ydWxlOmV2ZW5vZGQ7Y2xpcC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjI7Ij48cGF0aCBkPSJNMTEsNDBjLTAuOCwwIC0xLjUsLTAuMyAtMi4xLC0wLjljLTAuNiwtMC42IC0wLjksLTEuMyAtMC45LC0yLjFsMCwtNy4xNWwzLC0wbDAsNy4xNWwyNiwwbDAsLTcuMTVsMywtMGwwLDcuMTVjMCwwLjggLTAuMywxLjUgLTAuOSwyLjFjLTAuNiwwLjYgLTEuMywwLjkgLTIuMSwwLjlsLTI2LDBabTEzLC03LjY1bC05LjY1LC05LjY1bDIuMTUsLTIuMTVsNiw2bDAsLTE4LjU1bDMsLTBsMCwxOC41NWw2LC02bDIuMTUsMi4xNWwtOS42NSw5LjY1WiIgc3R5bGU9ImZpbGw6I2ZmZjtmaWxsLXJ1bGU6bm9uemVybzsiLz48L3N2Zz4=)](https://github.com/fatihbalsoy/material-board/releases/)
[![Demo](https://img.shields.io/badge/-Demo-446DFF?style=for-the-badge&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj48c3ZnIHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIHZpZXdCb3g9IjAgMCA0OCA0OCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4bWw6c3BhY2U9InByZXNlcnZlIiB4bWxuczpzZXJpZj0iaHR0cDovL3d3dy5zZXJpZi5jb20vIiBzdHlsZT0iZmlsbC1ydWxlOmV2ZW5vZGQ7Y2xpcC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjI7Ij48cGF0aCBkPSJNMTYsMzcuODVsMCwtMjhsMjIsMTRsLTIyLDE0Wm0zLC01LjQ1bDEzLjQ1LC04LjU1bC0xMy40NSwtOC41NWwwLDE3LjFaIiBzdHlsZT0iZmlsbDojZmZmO2ZpbGwtcnVsZTpub256ZXJvOyIvPjwvc3ZnPg==)](https://material-dashboard-demo.bal.soy/)

![WordPress](https://img.shields.io/badge/WordPress-6.3.1-lightblue?style=for-the-badge&logo=wordpress&logoWidth=20)
[![WordPress](https://img.shields.io/badge/WordPress-6.3.1-lightblue?style=for-the-badge&logo=wordpress&logoWidth=20)](https://wordpress.org/plugins/material-board/)
[![Build Status](https://img.shields.io/github/actions/workflow/status/fatihbalsoy/material-board/build.yml?style=for-the-badge&logo=github)](https://github.com/fatihbalsoy/material-board/actions/workflows/build.yml)

Read this document in a different language.
Expand All @@ -25,6 +25,8 @@ Read this document in a different language.

## Installation

Material Board is available on the WordPress Plugin Directory [(link)](https://wordpress.org/plugins/material-board/) and can be installed from the plugins page in your admin dashboard.

### Manually

* Download the latest release of Material Board [here](https://github.com/fatihbalsoy/material-board/releases/),
Expand All @@ -33,25 +35,6 @@ Read this document in a different language.
* Select the downloaded zip archive,
* Finally, activate the Material Board plugin.

### WP Pusher (Automatic Updates)

* Download the latest release of WP Pusher [here](https://wppusher.com/)
* On your WordPress dashboard go to `Plugins` > `Add New`,
* Click the `Upload Plugin` button near the header,
* Select the downloaded zip archive,
* Activate the WP Pusher plugin,
* Go to `WP Pusher` > `Install Plugin`,
* Choose Github as the Repository Host,
* Input this repository's [link](fatihbalsoy/material-board) into `Plugin Repository`,
* Input the deployment branch, release-deployed, into `Repository Branch`,
* Click `Install Plugin`,
* Finally, activate the Material Board plugin.

> ### ⚠️ NOTE
>
> This plugin is still in its pre-release phase and is not yet available on the WordPress Plugin Directory.
> Do not use WordPress' default updater to update the plugin. Disable Auto-Updates at the Plugins page.
## Customization

Head over to `Appearance` > `Material Board` to customize the dashboard colors and looks.
Expand Down
37 changes: 36 additions & 1 deletion src/readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,41 @@ Donate link: https://paypal.me/fatihbalsoy
Tags: material, design, dashboard
Tested up to: 6.3.1
Stable tag: 0.3.4
Requires at least: 5.8
Requires PHP: 7.0.0
License: AGPLv3 or later
License URI: https://www.gnu.org/licenses/agpl-3.0.html
Transform your dashboard with Material Board. Sleek, modern design following Google's Material Guidelines. No layout changes, branding, or costs.
Transform your dashboard with Material Board. Sleek, modern design following Google's Material Guidelines. No layout changes, branding, or costs.

The Material Board plugin for WordPress updates the appearance of your site's dashboard to a sleeker, more contemporary design based on [Google's Material Design Guidelines](https://material.io/design). This plugin preserves your existing dashboard layout, avoids making any significant alterations, and doesn't include any branding or promotional content. It's straightforward to use and comes at no cost.

## Customization

Head over to Appearance → Material Board to customize the dashboard colors and looks. Here are some of the available options:

- Theme (Light, Dark, and System)
- Colors (Primary and Accent colors)
- Toggle Rounded Corners
- Font (DM Sans, Roboto, Mona, Hubot, or WordPress)
- Header Font (Serif or sans serif)
- Icons (Material or WordPress)
- Large App Bar (Bar or Menu on top)

## Contribution
Feel free to submit a pull request on [GitHub](https://github.com/fatihbalsoy/material-board) for one of the following:

- New features
- Language translation [(Crowdin Page)](https://crowdin.com/project/material-dashboard)
- Support third-party plugins or themes
- Fixing bugs and security vulnurabilities

== Changelog ==
0.3.4:
- Initial alpha release on WordPress Plugin directory.

== Screenshots ==
1. Dashboard (Light/Dark)
2. Pages (Light)
3. Themes (Light)
4. Media Library (Light)
5. Pages (Dark)

0 comments on commit c7ee428

Please sign in to comment.