Skip to content
This repository was archived by the owner on Apr 28, 2026. It is now read-only.

Commit 8096013

Browse files
committed
Add example and limitations detail to the ReadMe.
1 parent c43c658 commit 8096013

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

ReadMe.rdoc

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,24 @@ their documentation in addition to this:
3434
{documentation}[http://mygrid.github.io/ruby-ucf]
3535

3636
There are some examples of how to use the library provided in the bin
37-
directory. See the contents of the tests directory for even more.
37+
directory:
38+
39+
* <tt>ro-bundle-info</tt>: Print out simple metrics about this RO Bundle. This
40+
is analogous to the standard <tt>zipinfo</tt> command.
41+
* <tt>verify-ro-bundle</tt>: Verify that the specified RO Bundle is valid.
42+
* <tt>dir2ro</tt>: Recursively package up a directory into a RO Bundle. All
43+
files in the directory are added as aggregates.
44+
* <tt>zip2ro</tt>: Copy all files from a normal zip file into a RO Bundle. All
45+
files in the zip file are added as aggregates.
46+
47+
See the contents of the tests directory for even more example usage.
48+
49+
== What this library cannot do yet
50+
51+
The {RO Bundle specification}[http://wf4ever.github.io/ro/bundle/] is largely
52+
implemented but there are notable gaps at present, including:
53+
54+
* Aggregates do not support ORE proxies yet.
55+
* Extra provenance information cannot yet be added using the <tt>pav:</tt>
56+
namespace.
57+
* The <tt>@graph</tt> member is not supported in the top-level manifest.

0 commit comments

Comments
 (0)