README.md in valkyrie-0.1.0 vs README.md in valkyrie-1.0.0.rc1
- old
+ new
@@ -1,9 +1,8 @@
# Valkyrie
-Valkyrie is a gem for enabling multiple backends for storage of files and metadata in Samvera,
-currently developed in a subdirectory of the [proof-of-concept app of the same name](..).
+Valkyrie is a gem for enabling multiple backends for storage of files and metadata in Samvera.
[](https://circleci.com/gh/samvera-labs/valkyrie)
[](https://coveralls.io/github/samvera-labs/valkyrie?branch=master)
[](https://waffle.io/samvera-labs/valkyrie)
@@ -123,17 +122,17 @@
To create a custom Valkyrie model in your application, you can use the Rails generator. For example, to
generate a model named `FooBar` with an unordered `title` field and an ordered `member_ids` field:
```
-rails generate valkyrie:model FooBar title member_ids:array
+rails generate valkyrie:resource FooBar title member_ids:array
```
You can namespace your model class by including a slash in the model name:
```
-rails generate valkyrie:model Foo/Bar title member_ids:array
+rails generate valkyrie:resource Foo/Bar title member_ids:array
```
### Read and Write Data
```
@@ -152,13 +151,19 @@
```
## Installing a Development environment
-See the parent app README for [instructions on setting up a development
-environment](../#installing-a-development-environment). To run the test suite:
-1. Start Solr and Fedora servers for testing with `rake server:test` in the parent app
-1. Run the gem's RSpec test suite with `cd valkyrie && rspec spec`
+### External Requirements
+* PostgreSQL with the uuid-ossp extension.
+ * Note: Enabling uuid-ossp requires database superuser privileges.
+ * From `psql`: `alter user [username] with superuser;`
+
+### To run the test suite
+1. Start Solr and Fedora servers for testing with `rake server:test`
+1. Run `rake db:create` (First time only)
+1. Run `rake db:migrate`
+1. Run the gem's RSpec test suite with `rspec spec` or `rake`
## License
Valkyrie is available under [the Apache 2.0 license](../LICENSE).