Skip to content

Commit f51f9da

Browse files
committed
Readme: Clarify scope of this package
1 parent bd87675 commit f51f9da

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,20 @@
88

99
# scriptotek/marc
1010

11-
A small PHP package providing a simple interface to work with MARC21 records
12-
on top of the excellent [File_MARC package](https://github.com/pear/File_MARC).
11+
This package provides a simple interface to work with MARC21 records using the excellent
12+
[File_MARC](https://github.com/pear/File_MARC) and [MARCspec](http://marcspec.github.io/)
13+
packages.
14+
It doesn't do any of the heavy lifting itself, but instead
1315

14-
Works with both Binary MARC and MARCXML (namespaced or not), but not the various
15-
Line mode MARC formats. Records can be edited using the editing capabilities of
16-
File_MARC.
16+
- makes it a little bit easier to load data by automatically determining what you throw
17+
at it (Binary MARC or MARCXML, namespaced XML or not, a collection of records in some
18+
container or a single record).
19+
- adds a few extra convenience methods and a fluent interface to MARCspec.
1720

18-
See [the changelog](CHANGELOG.md) for information about (breaking) changes.
19-
See [CONTRIBUTING.md](CONTRIBUTING.md) for information about contributing to the project.
21+
If you don't need any of this, you might want to use File_MARC directly instead.
22+
23+
Want to contribute to this project?
24+
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
2025

2126
## Installation using Composer:
2227

@@ -74,6 +79,13 @@ use Scriptotek\Marc\Record;
7479
$record = Record::fromFile($someFileName);
7580
```
7681

82+
## Editing records
83+
84+
Records can be edited using the editing capabilities of File_MARC
85+
([API docs](https://pear.php.net/package/File_MARC/docs/latest/)).
86+
See [an example](https://github.com/scriptotek/php-marc/issues/13#issuecomment-522036879)
87+
to get started.
88+
7789
## Querying with MARCspec
7890

7991
Use the `Record::query()` method to query a record using the

0 commit comments

Comments
 (0)