glenux/fosdem-recorder.cr
glenux/fosdem-recorder.cr
1
1
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Glenn Y. Rolland 2021-02-07 21:45:08 +01:00
parent 9457717cfc
commit dcc77aeff5
1 changed files with 11 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -3,24 +3,28 @@
## Prerequisites
* Make sure you have Ruby installed
* Make sure you have a recent Ruby version installed
* Make sure you have the 'bundler' Gem installed
## Installation
Install project dependencies
$ bundle install
## Usage
Get information about given URL
$ bundle exec fosdem-recorder info URL
$ fosdem_recorder info URL
Schedule video download for given URL
$ bundle exec fosdem-recorder download URL
$ fosdem_recorder download URL
Real example
@ -33,42 +37,18 @@ $ bundle exec fosdem-recorder info https://fosdem.org/2021/schedule/event/sca_we
* url = https://stream.fosdem.org/dcomposition.m3u8
$ bundle exec fosdem-recorder info https://fosdem.org/2021/schedule/event/sca_weclome/
[... schedules the download ... ]
[... schedules the download with 'at'... ]
[... downloads the file with 'ffmpeg'... ]
[... a MP4 file will be created once the video is downloaded ...]
```
# Fosdem
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/fosdem`. To experiment with that code, run `bin/console` for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'fosdem'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install fosdem
## Usage
TODO: Write usage instructions here
## 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/glenux/fosdem.
Bug reports and pull requests are welcome on GitHub at https://github.com/glenux/fosdem-recorder.