summaryrefslogtreecommitdiffstats
path: root/readme.txt
blob: 5671c0faa2c36d0045e014e2633f00434cdcd457 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
=== danixland-asciinema ===

Contributors: danixland
Donate link: http://danixland.net
Tags: asciinema, shortcode, video
Requires at least: 3.0.1
Tested up to: 4.9.6
Stable tag: 0.1
License: GPLv2 or later

This plugin adds a shortcode that displays a video from <a href="https://asciinema.org">asciinema.org</a>.

== Description ==

danixland-asciinema is a plugin that adds a new shortcode to be used whenever you want to embed a video from asciinema.org.

As stated on their website, asciinema (formerly ascii.io) is a free and open source solution for recording terminal sessions and sharing them on the web.
It aims to be a "go to" place for every command-line user who wants to share their skills with others. Or putting it differently, it's a place to show off your geekiness.

I decided to make this plugin because I was looking for a good and easy way to share a video from asciinema and I'm too lazy to dwelve into oEmbed :-D

== Installation ==

Installing danixland-asciinema is straightforward and requires just a few seconds:

If you use the **"Add New Plugin"** pane from your dashboard just install it and activate it, nothing to configure here, just go ahead and use it.
Otherwise follow these steps:

1. Download the latest version of the plugin.
1. If using the "Install Plugins->Upload" section on the WordPress admin area just upload the zip file, otherwise unpack the zip file and upload the **"danixland-asciinema"** directory inside the "wp-content/plugins" directory of your WordPress installation using your favourite ftp client.
1. Activate the plugin through the 'Plugins' menu in WordPress and you're ready to go!!

== Frequently Asked Questions ==

= What are the options that I can use with the shortcode? =

The most important option is the "video" which you can assign to the number of the video you want to embed, let's say you want to embed `https://asciinema.org/a/14829` the shortcode whould be `[asciinema video=14829]`
The full list of options is:

* video
* time
* autoplay
* loop
* speed
* theme

You can read about their usage [on the website](https://asciinema.org/docs/embedding).

= I'm stuck with your plugin and don't seem to be able to customize it/make it work, can you help me? =

Of course, you can ask for help on [the forums](http://wordpress.org/support/) or write a comment on the main article for this plugin on [my site](http://danixland.net/?p=3525), I'll reply ASAP ;)

= I'd like this plugin to be translated in my language, can you do this for me? =

This plugin doesn't output any text other than the video code, so it doesn't provide/need a translation ;)

####If you have any other questions feel free to ask

== Screenshots ==

1. The shortcode with few options as seen in the admin area of the website
2. A sample video displayed in single view with the TwentyFifteen theme

== Changelog ==

= 0.1 =
* This is the first version of the plugin.

== Upgrade Notice ==

Thank you Mario! But our princess is in another castle!

== ToDo list ==

List is actually empty, but I'm open to suggestions.