mediaxml - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

package.json

 {
   "name": "mediaxml",
-  "version": "0.2.0",
-  "description": "A module for working with media manifests represented by XML like ADI, mRSS, and SCTE236.",
+  "version": "0.2.1",
+  "description": "A general purpose module for working with XML that includes first class support for media manifests like ADI, mRSS, and SCTE-236.",
   "scripts": {
@@ -6,0 +6,0 @@ "test": "tape tests",

README.md

 mediaxml
 ========
 
-> A module for working with media manifests represented by XML like ADI, mRSS, and SCTE-236.
+> A general purpose module for working with XML that includes first
+> class support for media manifests like ADI, mRSS, and SCTE-236.
 
@@ -157,3 +158,3 @@ ## Status
 
-const document = Document.from(createReadStream('file.rss'))
+cont document = Document.from(createReadStream('file.rss'))
 document.ready(() => {
@@ -166,3 +167,47 @@ const items = document.query('channel.items')
 
-See the [Documentation](https://little-core-labs.github.io/mediaxml) for
+### REPL
+
+A [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) is
+provided for interactive querying of data in a XML tree.
+
+The REPL can be started by simply running the `mxml`:
+
+```sh
+$ mxml
+Welcome to the MediaXML 0.2.0 CLI
+Please report bugs to https://github.com/little-core-labs/mediaxml/issues
+mxml(-)>
+```
+
+Importing a file can be done with the `import` keyword. This will import
+an XML file into the REPL context.
+
+```js
+mxml(-)> import "./example/mrss/feed.xml"
+mxml(-)> this
+<rss>
+  <channel>
+    <title>Calm Meditation</title>
+    <link>http://sample-firetv-web-app.s3-website-us-west-2.amazonaws.com</link>
+    <language>en-us</language>
+    ...
+```
+
+In the REPL, you can use the query syntax (JSONata with sugar) to query
+data.
+
+```js
+mxml(-)> **[is node and text contains "amazonaws.com"] // searches all nodes with '**' wildcard operator
+<link>http://sample-firetv-web-app.s3-website-us-west-2.amazonaws.com</link>
+<link>http://sample-firetv-web-app.s3-website-us-west-2.amazonaws.com</link>
+<url>http://sample-firetv-web-app.s3-website-us-west-2.amazonaws.com/images/calmmeditationlogo_small.png</url>
+<link>http://sample-firetv-web-app.s3-website-us-west-2.amazonaws.com/shade/</link>
+<guid isPermaLink="false">http://sample-firetv-web-app.s3-website-us-west-2.amazonaws.com/shade/</guid>
+<link>http://sample-firetv-web-app.s3-website-us-west-2.amazonaws.com/spectators/</link>
+<guid isPermaLink="false">http://sample-firetv-web-app.s3-website-us-west-2.amazonaws.com/spectators/</guid>
+```
+
+### Documentation
+
+See the [Official Documentation](https://little-core-labs.github.io/mediaxml) for
 more information.
@@ -169,0 +214,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2522138

increased by0.07%

Number of lines in readme file

225

increased by25%

No dependency changes