README.textile in solrizer-fedora-2.0.0 vs README.textile in solrizer-fedora-2.1.0
- old
+ new
@@ -2,11 +2,11 @@
An extension to projecthydra/solrizer that provides utilities for loading objects from Fedora Repositories and creating solr documents from them.
h2. Installation
-The gem is hosted on rubygems.org. The bset way to manage the gems for your project is to use bundler. Create a Gemfile in the root of your application and include the following:
+The gem is hosted on rubygems.org. The best way to manage the gems for your project is to use bundler. Create a Gemfile in the root of your application and include the following:
<pre>
source "http://rubygems.org"
gem 'solrizer-fedora'
@@ -15,42 +15,14 @@
Then:
<pre>bundle install</pre>
-h2. Testing
+h2. Pre-requisite to Use of Solrizer-Fedora
-In order to run the RSpec tests, it is necesary to have a hydra-jetty instance running. This can be accomplished two ways:
+In order to use solrizer-fedora, you must have a Solr and a Fedora instance available. The easiest approach is to set up an instance of "hydra-jetty":https://github.com/projecthydra/hydra-jetty.
-h3. Using the bundled jetty instance:
-
-Configure the bundled hydra-jetty instance.
-
-<pre>
-git submodule init
-git submodule update
-</pre>
-
-Once you have updated the jetty submodule, you can easily run the rspec tests with the following rake task:
-
-<pre>
-rake hudson
-</pre>
-
-While the primary intention of this task is to provide test coverage and documentation out on projecthydra's "continuous integration server":http://hudson.projecthydra.org, it can also be used locally to run tests without having to install and configure an instance of "hydra-jetty":https://github.com/projecthydra/hydra-jetty.
-
-Note: if you have another instance of hydra-jetty running, you should either close it down prior to running the rake hudson task.
-
-
-h3. Using a different instance of hydra-jetty:
-
-If you prefer, you can run the specs against a different hydra-jetty instance. Follow the instructions included with those projects to start the jetty instance.
-
-
-
-h2. Pre-requisite
-
h3. Setup local hydra-jetty
In order to use solrizer-fedora, you must first set up an instance of "hydra-jetty":https://github.com/projecthydra/hydra-jetty.
Once you have set this up, cd into the directory and type:
@@ -157,11 +129,11 @@
<pre>
solrizer.solrize_objects
</pre>
-h3. Advanced usage
+h3. Advanced Usage
Solrizer-fedora inspects your repository objects and attempts to match your objects to your ruby models based on the hasModel declarations in the RELS-EXT datastream.
Go to the fedora admin interface (http://FEDORA_BASE_URL/fedora/admin) and create a new object with an PID of "changeme:123" and whatever Label you want.
@@ -208,20 +180,46 @@
<str>bar</str>
</arr>
</pre>
+h2. Modifying and Testing the Solrizer-Fedora gem
+In order to run the RSpec tests, it is necessary to have a hydra-jetty instance running. This can be accomplished two ways:
+h3. Using the bundled jetty instance:
+Configure the bundled hydra-jetty instance.
+<pre>
+git submodule init
+git submodule update
+</pre>
+
+Once you have updated the jetty submodule, you can easily run the rspec tests with the following rake task:
+
+<pre>
+rake hudson
+</pre>
+
+While the primary intention of this task is to provide test coverage and documentation out on projecthydra's "continuous integration server":http://hudson.projecthydra.org, it can also be used locally to run tests without having to install and configure an instance of "hydra-jetty":https://github.com/projecthydra/hydra-jetty.
+
+Note: if you have another instance of hydra-jetty running, you should either close it down prior to running the rake hudson task.
+
+
+h3. Using a different instance of hydra-jetty:
+
+If you prefer, you can run the specs against a different hydra-jetty instance. Follow the instructions included with those projects to start the jetty instance.
+
+
+
h2. Note on Patches/Pull Requests
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so it doesn't get broken unintentionally
in a future version.
-* Commit, do not mess with rakefile, version, or history.
+* Commit, do not mess with rake file, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
h2. Copyright