Skip to content

Commit c2ae711

Browse files
committed
a better readme
1 parent 5422bc1 commit c2ae711

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
# as_getty_barcodes
2-
An ArchivesSpace plugin that adds the ability to download DataMatrix barcodes for AO Ref IDs
2+
3+
An ArchivesSpace plugin that adds the ability to download DataMatrix
4+
barcodes for Archival Object Ref IDs.
5+
6+
Compatible with ArchivesSpace v3.2.0. It will likely be fine on any
7+
recent version, but only tested on v3.2.0.
8+
9+
Developed by Hudson Molonglo for the J. Paul Getty Trust.
10+
11+
12+
## Installation
13+
14+
No special installation instructions.
15+
No Gems. No database migrations. No overridden templates.
16+
17+
18+
## Description
19+
20+
Adds a button to the Archival Object toolbar. When clicked a Datamatrix
21+
barcode is generated using the AO's Ref Id, and is downloaded as a PNG image.
22+
23+
The name of the file is based on the AO's Component Unique Identifier (CUI)
24+
as follows:
25+
```
26+
barcode_[CUI].png
27+
```
28+
29+
## Dependencies
30+
31+
This plugin uses two open source java libraries to generate barcodes:
32+
- [barcode4j.jar](https://barcode4j.sourceforge.net/)
33+
- [jai-imageio-core-1.4.0.jar](https://mvnrepository.com/artifact/com.github.jai-imageio/jai-imageio-core)
34+
35+
These are bundled with the plugin.

0 commit comments

Comments
 (0)