README.md in archivesspace-client-0.1.3 vs README.md in archivesspace-client-0.1.4
- old
+ new
@@ -1,12 +1,10 @@
-Archivesspace Client
-===
+# Archivesspace Client
-Interact with ArchivesSpace via its API.
+Interact with ArchivesSpace via the API.
-Installation
----
+## Installation
Add this line to your application's Gemfile:
```ruby
gem 'archivesspace-client'
@@ -18,14 +16,15 @@
bundle install
```
Or install it yourself as:
- $ gem install archivesspace-client
+```bash
+gem install archivesspace-client
+```
-Usage
----
+## Usage
See the examples directory for a range of use cases.
**Default configuration**
@@ -35,12 +34,10 @@
client = ArchivesSpace::Client.new.login
```
**Custom configuration**
-To supply custom configuration to client:
-
```ruby
config = ArchivesSpace::Configuration.new({
base_uri: "https://archives.university.edu/api",
base_repo: "",
username: "admin",
@@ -88,33 +85,44 @@
# to reset
client.config.base_repo = ""
```
-Development
----
+## Development
To run the examples start a local instance of ArchivesSpace then:
```bash
bundle exec ruby examples/repo_and_user.rb
```
-Any script placed in the examples directory with a `my_` prefix are ignored by git. Follow the convention used by the existing scripts to bootstrap and experiment away.
+Any script placed in the examples directory with a `my_` prefix are ignored by
+git. Follow the convention used by the existing scripts to bootstrap and
+experiment away.
To run the tests:
```bash
bundle exec rake
```
-Contributing
----
+## Publishing
+Bump version in `lib/archivesspace/client/version.rb` then:
+
+```bash
+VERSION=0.1.4
+gem build archivesspace-client
+gem push archivesspace-client-$VERSION.gem
+git tag v$VERSION
+git push --tags
+```
+
+## Contributing
+
Bug reports and pull requests are welcome on GitHub at https://github.com/lyrasis/archivesspace-client.
-License
----
+## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
---