Sha256: 55f89b08c5c84a16b4b4d6f8439aad5606f787eae63257cc40dcf3c41d75b053

Contents?: true

Size: 1.57 KB

Versions: 12

Compression:

Stored size: 1.57 KB

Contents

[![Build Status](https://travis-ci.org/datacite/maltese.svg?branch=master)](https://travis-ci.org/datacite/maltese)
[![Code Climate](https://codeclimate.com/github/datacite/maltese/badges/gpa.svg)](https://codeclimate.com/github/datacite/maltese)
[![Test Coverage](https://codeclimate.com/github/datacite/maltese/badges/coverage.svg)](https://codeclimate.com/github/datacite/maltese/coverage)

# Maltese

Ruby gem and command-line tool for generating sitemap files from the DataCite REST API. Uses the [SitemapGenerator](https://github.com/kjvarga/sitemap_generator) gem and can be run as Docker container, e.g. using as a scheduled task in AWS ECS triggered by AWS Cloudwatch Events.

Run as a command-line tool:

```ruby
maltese sitemap
```

## Installation

Requires Ruby 2.2 or later. Then add the following to your `Gemfile` to install the
latest version:

```ruby
gem 'maltese'
```

Then run `bundle install` to install into your environment.

You can also install the gem system-wide in the usual way:

```bash
gem install maltese
```

## Development

We use rspec for unit testing:

```ruby
bundle exec rspec
```

Follow along via [Github Issues](https://github.com/datacite/toccatore/issues).

### Note on Patches/Pull Requests

* Fork the project
* Write tests for your new feature or a test that reproduces a bug
* Implement your feature or make a bug fix
* Do not mess with Rakefile, version or history
* Commit, push and make a pull request. Bonus points for topical branches.

## License

**maltese** is released under the [MIT License](https://github.com/datacite/maltese/blob/master/LICENSE.md).

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
maltese-0.9.12 README.md
maltese-0.9.11 README.md
maltese-0.9.10 README.md
maltese-0.9.8 README.md
maltese-0.9.7 README.md
maltese-0.9.6 README.md
maltese-0.9.5 README.md
maltese-0.9.4 README.md
maltese-0.9.3 README.md
maltese-0.9.2 README.md
maltese-0.9.1 README.md
maltese-0.9.0 README.md