README.md in purl_fetcher-client-1.0.0 vs README.md in purl_fetcher-client-1.1.0
- old
+ new
@@ -20,10 +20,28 @@
$ gem install purl_fetcher-client
## Usage
-TODO: Write usage instructions here
+### Uploading a file
+
+```ruby
+PurlFetcher::Client.configure(url:'http://127.0.0.1:3000', token: 'abc123')
+
+PurlFetcher::Client::UploadFiles.upload(
+ file_metadata: {
+ 'file1.txt' => PurlFetcher::Client::DirectUploadRequest.new(
+ checksum: '123',
+ byte_size: 10_000,
+ content_type: 'image/tiff',
+ filename: 'image.tiff'
+ )
+ },
+ filepath_map: {
+ 'file1.txt' => File.expand_path('Gemfile.lock')
+ }
+)
+```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.