README.md in ssmd-0.7.3 vs README.md in ssmd-0.7.4
- old
+ new
@@ -1,10 +1,10 @@
# SSMD
[![Build Status](https://travis-ci.org/machisuji/ssmd.svg?branch=master)](https://travis-ci.org/machisuji/ssmd)
-Speech Synthesis Markdown (SSMD) is an lightweight alternative syntax for [SSML](https://www.w3.org/TR/speech-synthesis/).
+Speech Synthesis Markdown (SSMD) is a lightweight alternative syntax for [SSML](https://www.w3.org/TR/speech-synthesis/).
This repository contains both the reference implementation of the SSMD-to-SSML conversion tool (`ssmd`) as well
as the [specification](SPECIFICATION.md) of the language.
## Requirements
@@ -26,17 +26,32 @@
$ gem install ssmd
## Usage
+You can convert SSML to SSMD using `SSMD::to_ssml`:
+
```ruby
require 'ssmd'
ssmd = "hello *SSMD*!"
ssml = SSMD.to_ssml ssmd
puts ssml
# Output: <speak>hello <emphasis>SSMD</emphasis>!</speak>
+```
+
+Sometimes you will want to see just the plain text without any SSMD annotations.
+For this you can use `SSMD::stip_ssmd`:
+
+```ruby
+require 'ssmd'
+
+ssmd = "[hallo](de) *SSMD*!"
+plain_text = SSMD.strip_ssmd ssmd
+
+puts plain_text
+# Output: hallo SSMD!
```
**Note:**
This version is still under development. See below which essential SSML constructs are implemented so far: