README.md in longleaf-0.3.0 vs README.md in longleaf-1.0.0
- old
+ new
@@ -1,9 +1,9 @@
# Longleaf
Code: [](https://circleci.com/gh/UNC-Libraries/longleaf-preservation)
-Longleaf is a command-line tool which allows users to configure a set of storage locations and define custom sets of preservation services to run on their contents. These services are executed in response to applicable preservation events issued by clients. Its primary goal is to provide tools to create a simple and customizable preservation environment. Longleaf:
+Longleaf is a command-line tool which allows users to configure a set of storage locations and define custom sets of preservation services to run on their contents. These services are executed in response to applicable preservation events issued by clients. Its primary goal is to provide tools to create a simple and customizable preservation environment. Longleaf:
* Offers a predictable command-line interface and integrates with standard command-line tools.
* Offers configurable and customizable criteria based preservation workflows.
* Provides a base set of tools and a framework for building extensions.
* Provides activity logging and notifications.
@@ -105,9 +105,19 @@
```
bundle install --with postgres
```
Options include: postgres, mysql2, mysql, sqlite, amalgalite
+
+To setup an index, you will need to add a `system > index` section to your configuration with the details of the database to use for the index. Then to setup the database, run:
+
+```
+longleaf setup_index -c <config_file>
+```
+And for a one-time indexing:
+```
+longleaf reindex -c <config_file>
+```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/UNC-Libraries/longleaf-preservation.