Skip to content

Commit a9c8c84

Browse files
committed
Upate readme to reflect changes in the project
1 parent 1cc121c commit a9c8c84

File tree

1 file changed

+29
-18
lines changed

1 file changed

+29
-18
lines changed

README.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
11
![Metafacture](https://raw.github.com/wiki/culturegraph/metafacture-core/img/metafacture.png)
22

3-
Metafacture is a toolkit for processing semi-structured data with a focus on library metadata. It provides a versatile set of tools for reading, writing and transforming data. Metafacture can be used as a stand-alone application or as a java library in other applications. The name Metafacture is a portmanteau of the words *meta* data and manu*facture*.
3+
Metafacture is a toolkit for processing semi-structured data with a focus on library metadata. It provides a versatile set of tools for reading, writing and transforming data. Metafacture can be used as a stand-alone application or as a Java library in other applications. The name Metafacture is a portmanteau of the words *meta* data and manu*facture*.
44

5-
Metafacture consists of a core library and a number of plugin packages and satellite projects which build on the core library and extend it with additional tools and features. This page describes the core package. Have a look at the [Plugins and Tools page](https://github.com/culturegraph/metafacture-core/wiki/Plugins-and-Tools) on the wiki for an overview of the supplementary packages and projects.
5+
Metafacture includes a large number of modules for operating on semi-structured data. These modules can be combined to build pipelines to perform complex metadata processing tasks. The pipelines can be constructed either in Java code or with the domain-specific language **Flux**. One of the core features of Metafacture is the **Metamorph** module. Metamorph is an xml-based language for specifying transformations of semi-structured data. It can be seamlessly integrated into Java code.
66

7-
Originally, Metafacture was developed as part of the [Culturegraph](http://culturegraph.org) platform but its now used by others, too: [see who uses Metafacture](https://github.com/culturegraph/metafacture-core/wiki/Who-uses-Metafacture).
7+
At its heart Metafacture is a framework for implementing modules for metadata processing. This makes Metafacture easily extendable with additional modules. The [plugins and tools page](https://github.com/culturegraph/metafacture-core/wiki/Plugins-and-Tools) on the wiki shows supplementary packages and projects which extend Metafacture.
8+
9+
Originally, Metafacture was developed as part of the [Culturegraph](http://culturegraph.org) platform but it is developed independently now and used by others, too: [see who uses Metafacture](https://github.com/culturegraph/metafacture-core/wiki/Who-uses-Metafacture).
810

911
# Getting started
1012

11-
You can use Metafacture either as a stand-alone application or as a Java library in your own projects.
13+
You can either use Metafacture as a stand-alone application or include it as a Java library in your own projects.
1214

1315
## Metafacture as a stand-alone application
1416

1517
If you are only interested in running Flux scripts without doing any Java programming this is the way to go. The instructions assume that you are using a *nix-like shell.
1618

17-
1. Download the latest distribution package from the [metafacture-core/releases](https://github.com/culturegraph/metafacture-core/releases) page. Make sure that you do download a distribution package and _not_ a source code package.
19+
1. Download the latest distribution package from the [metafacture-core/releases](https://github.com/culturegraph/metafacture-core/releases) page. Make sure that you do download a distribution package and _not_ a source code package (the file name should include *-dist*).
1820

1921
2. Extract the downloaded archive:
2022
```bash
21-
$ tar xzf metafacture-runner-VERSION-dist.tar.gz
23+
$ tar xzf metafacture-core-VERSION-dist.tar.gz
2224
```
2325
This will create a new directory containing a ready-to-use metafacture distribution.
2426
3. Change into the newly created directory:
2527
```bash
26-
$ cd metafacture-runner-VERSION
28+
$ cd metafacture-core-VERSION
2729
```
2830
4. Run one of the example scripts:
2931
```bash
@@ -36,21 +38,30 @@ The _examples_ folder contains many more examples which provide a good starting
3638

3739
## Using Metafacture as a Java libary
3840

39-
If you want use Metafacture in your own Java projects all you need to do is to include the metafacture-core package as a dependency in your project. metafacture-core is available from [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.culturegraph%22). To use it, add the following dependency declaration to your `pom.xml`:
41+
If you want use Metafacture in your own Java projects all you need to add some dependencies to your project. As of Metafacture 5 the single metafacture-core package has been replaced with a number of domain-specific packages. You can find the list of packages on [Maven Central](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.metafacture%22).
4042

41-
<dependency>
42-
<groupId>org.culturegraph</groupId>
43-
<artifactId>metafacture-core</artifactId>
44-
<version>4.0.0</version>
45-
</dependency>
43+
Alternatively, you can simply guess the package names from the top-level folders in the source code repository -- they are the same. For instance, if you want to use Metamorph in your project, simply add the following dependency to your `pom.xml`:
4644

47-
Our integration server automatically publishes successful builds of the master branch as snapshot versions on [Sonatype OSS Repository](https://oss.sonatype.org/index.html#nexus-search;quick~culturegraph).
45+
```xml
46+
<dependency>
47+
<groupId>org.metafacture</groupId>
48+
<artifactId>metamorph</artifactId>
49+
<version>VERSION</version>
50+
</dependency>
51+
```
4852

49-
<!--
50-
TODO: Add
53+
or if Gradle is your build tool of choice use:
54+
55+
```groovy
56+
dependencies {
57+
implementation 'org.metafacture:metamorph:VERSION'
58+
}
59+
```
5160

52-
* Link to getting started tutorial
53-
* Mention the application-archetype
61+
Our integration server automatically publishes successful builds of all branches as snapshot versions on [Sonatype OSS Repository](https://oss.sonatype.org/index.html#nexus-search;quick~culturegraph). The version number is derived from the branch name. Snapshot builds from the master branch always have the version "master-SNAPSHOT".
62+
63+
<!--
64+
TODO: Link to getting started tutorial
5465
-->
5566

5667
# Building metafacture-core from source

0 commit comments

Comments
 (0)