Skip to content

Commit

Permalink
docs: update README, start changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
henryiii committed Feb 4, 2021
1 parent e186d24 commit 98a0442
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 5 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Version 0.1.0

First version to be published, pulled from the IRIS-HEP website.

Extra features added during the transition include:
* Config settings for IDs and data path.
* `jekyll-indico-cache` script has customizable `--config` location.
* Some basic unit testing
* Better separation into files
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ indico:
```
This plugin will automatically sign your requests if your environment contains
`INDICO_API` and `INDICO_SECRET_KEY`.

#### Usage: installing


Expand Down Expand Up @@ -57,3 +60,10 @@ bundle install --path vendor/bundle
bundle exec rake
```

To release, make sure the version is new then:

```bash
bundle exec rake publish
```

This tags, pushes the tag, and publishes.
6 changes: 1 addition & 5 deletions jekyll-indico.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,13 @@ Gem::Specification.new do |spec|
spec.name = 'jekyll-indico'
spec.version = JekyllIndico::VERSION
spec.authors = ['Henry Schreiner']
spec.email = ['[email protected]']
spec.email = ['[email protected]']

spec.summary = 'Read and/or cache indico meeting lists for Jekyll'
spec.homepage = 'https://rubygems.org/gems/jekyll-indico'
spec.license = 'MIT'

# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
# to allow pushing to a single host or delete this section to allow pushing to any host.
if spec.respond_to?(:metadata)
spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"

spec.metadata['homepage_uri'] = spec.homepage
spec.metadata['source_code_uri'] = 'https://github.com/iris-hep/jekyll-indico'
spec.metadata['changelog_uri'] = 'https://github.com/iris-hep/jekyll-indico/blob/main/CHANGELOG.md'
Expand Down

0 comments on commit 98a0442

Please sign in to comment.