1
0
Fork 0
mirror of https://github.com/fog/fog-aws.git synced 2022-11-09 13:50:52 -05:00

Add bin/setup and bin/console with instructions on README

This commit is contained in:
Gustavo Sobral 2019-11-11 22:09:40 +01:00
parent c6b98a3a4c
commit 6fb9c3c807
3 changed files with 27 additions and 1 deletions

View file

@ -75,7 +75,7 @@ instance = ec2.servers.get("i-02db5af4")
instance.destroy
```
`Fog::AWS` is more than EC2 since it supports many services provided by AWS. The best way to learn and to know about how many services are supported is to take a look at the source code. To review the tests directory and to play with the library in ```irb``` can be very helpful resources as well.
`Fog::AWS` is more than EC2 since it supports many services provided by AWS. The best way to learn and to know about how many services are supported is to take a look at the source code. To review the tests directory and to play with the library in ```bin/console``` can be very helpful resources as well.
### S3
@ -109,6 +109,10 @@ directory.files.new(key: 'user/1/Gemfile').url(Time.now + 60)
See the [online documentation](http://www.rubydoc.info/github/fog/fog-aws) for a complete API reference.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
## Contributing
1. Fork it ( https://github.com/fog/fog-aws/fork )

14
bin/console Executable file
View file

@ -0,0 +1,14 @@
#!/usr/bin/env ruby
require "bundler/setup"
require "fog-aws"
# You can add fixtures and/or initialization code here to make experimenting
# with your gem easier. You can also use a different console, if you like.
# (If you use this, don't forget to add pry to your Gemfile!)
# require "pry"
# Pry.start
require "irb"
IRB.start(__FILE__)

8
bin/setup Executable file
View file

@ -0,0 +1,8 @@
#!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'
set -vx
bundle install
# Do any other automated setup that you need to do here