README.md in chronicle-shell-0.1.0 vs README.md in chronicle-shell-0.2.0

- old
+ new

@@ -1,39 +1,19 @@ # Chronicle::Shell -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chronicle/shell`. To experiment with that code, run `bin/console` for an interactive prompt. +Shell importer for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl) -TODO: Delete this and the text above, and describe your gem +## Available Connectors +### Extractors +- `shell-history` - Extract shell history from bash or zsh -## Installation +### Transformers +- `shell-history` - Process a shell command -Add this line to your application's Gemfile: - -```ruby -gem 'chronicle-shell' -``` - -And then execute: - - $ bundle install - -Or install it yourself as: - - $ gem install chronicle-shell - ## Usage -TODO: Write usage instructions here +```bash +gem install chronicle-etl +chronicle-etl connectors:install shell -## Development - -After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. - -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org). - -## Contributing - -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chronicle-shell. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/chronicle-shell/blob/main/CODE_OF_CONDUCT.md). - -## Code of Conduct - -Everyone interacting in the Chronicle::Shell project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chronicle-shell/blob/main/CODE_OF_CONDUCT.md). +chronicle-etl --extractor shell-history --since "2022-02-07" --transformer shell-history --loader table +```