readme.txt

   1 === danixland-asciinema ===
   2
   3 Contributors: danixland
   4 Donate link: https://danix.xyz
   5 Tags: asciinema, shortcode, video
   6 Requires at least: 3.0.1
   7 Tested up to: 4.9.6
   8 Stable tag: 0.1
   9 License: GPLv2 or later
  10 License URI: http://www.gnu.org/licenses/gpl-2.0.html
  11
  12 This plugin adds a shortcode that displays a video from <a href="https://asciinema.org">asciinema.org</a>.
  13
  14 == Description ==
  15
  16 danixland-asciinema is a plugin that adds a new shortcode to be used whenever you want to embed a video from asciinema.org.
  17
  18 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.
  19 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.
  20
  21 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
  22
  23 == Installation ==
  24
  25 Installing danixland-asciinema is straightforward and requires just a few seconds:
  26
  27 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.
  28 Otherwise follow these steps:
  29
  30 1. Download the latest version of the plugin.
  31 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.
  32 1. Activate the plugin through the 'Plugins' menu in WordPress and you're ready to go!!
  33
  34 == Frequently Asked Questions ==
  35
  36 = What are the options that I can use with the shortcode? =
  37
  38 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]`
  39 The full list of options is:
  40
  41 * video
  42 * time
  43 * autoplay
  44 * loop
  45 * speed
  46 * theme
  47
  48 You can read about their usage [on the website](https://asciinema.org/docs/embedding).
  49
  50 = I'm stuck with your plugin and don't seem to be able to customize it/make it work, can you help me? =
  51
  52 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 ;)
  53
  54 = I'd like this plugin to be translated in my language, can you do this for me? =
  55
  56 This plugin doesn't output any text other than the video code, so it doesn't provide/need a translation ;)
  57
  58 ####If you have any other questions feel free to ask
  59
  60 == Screenshots ==
  61
  62 1. The shortcode with few options as seen in the admin area of the website
  63 2. A sample video displayed in single view with the TwentyFifteen theme
  64
  65 == Changelog ==
  66
  67 = 0.1 =
  68 * This is the first version of the plugin.
  69
  70 == Upgrade Notice ==
  71
  72 Thank you Mario! But our princess is in another castle!
  73
  74 == ToDo list ==
  75
  76 List is actually empty, but I'm open to suggestions.
  77