Skip to content

Commit 10b7579

Browse files
committed
Release 0.1.0.
1 parent 312bdf0 commit 10b7579

File tree

6 files changed

+23
-5
lines changed

6 files changed

+23
-5
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
## 0.1.0 - 2018-08-05
4+
5+
* First release.

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A Gutenberg block for editing and displaying code with syntax highlighting.
44

5-
![Screenshot of the code block editor showing available settings and syntax highlighting.](screenshot-1.png)
5+
![Animation showing how to convert a code block, set the code language, and change the syntax highlight theme.](screenshot-1.gif)
66

77
## Features
88

@@ -34,11 +34,24 @@ _CodeMirror and Prism.js don't tokenize code exactly the same, so there will lik
3434

3535
## Installation
3636

37-
Shiny Code should be considered experimental while [Gutenberg](https://github.com/WordPress/gutenberg) is still in development. As such, it's currently only available from source:
37+
To install _Shiny Code_:
38+
39+
1. [Download the latest release](https://github.com/cedaro/shiny-code/releases/latest) from GitHub (the saved file should be named `shiny-code-{version}.zip`).
40+
2. Go to the _Plugins → Add New_ screen in your WordPress admin panel.
41+
3. Click the __Upload__ button at the top next to the “Add Plugins” title.
42+
4. Upload the zip file downloaded in the first step.
43+
5. Click the __Activate Plugin__ link after installation completes.
44+
45+
### From Source
46+
47+
To build _Shiny Code_ from source, clone this repository in `wp-content/plugins/`, then run the build steps:
3848

3949
```shell
4050
git clone https://github.com/cedaro/shiny-code.git
51+
cd shiny-code
4152
composer install
4253
npm install
4354
npm run build
4455
```
56+
57+
After building the plugin, go to the _Plugins → Installed Plugins_ screen in your WordPress admin panel to activate _Shiny Code_.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "shiny-code",
3-
"version": "0.1.0-dev",
3+
"version": "0.1.0",
44
"description": "A Gutenberg block for editing and displaying code with syntax highlighting.",
55
"homepage": "https://www.cedaro.com/",
66
"license": "GPL-2.0-or-later",

screenshot-1.gif

241 KB
Loading

screenshot-1.png

-201 KB
Binary file not shown.

shiny-code.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* Plugin Name: Shiny Code
1111
* Plugin URI: https://github.com/cedaro/shiny-code
1212
* Description: A Gutenberg block for editing and displaying code with syntax highlighting.
13-
* Version: 0.1.0-dev
13+
* Version: 0.1.0
1414
* Author: Cedaro
1515
* Author URI: https://www.cedaro.com/
1616
* License: GPL-2.0-or-later
@@ -38,7 +38,7 @@
3838
*
3939
* @var string
4040
*/
41-
const VERSION = '0.1.0-dev';
41+
const VERSION = '0.1.0';
4242

4343
/**
4444
* Load the Composer autoloader.

0 commit comments

Comments
 (0)