File: README.md

package info (click to toggle)
ruby-fog-local 0.8.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 212 kB
  • sloc: ruby: 709; makefile: 2
file content (44 lines) | stat: -rw-r--r-- 1,077 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# Fog::Local

![Gem Version](https://badge.fury.io/rb/fog-local.svg)
[![Build Status](https://travis-ci.org/fog/fog-local.svg?branch=master)](https://travis-ci.org/fog/fog-local)
[![Dependency Status](https://gemnasium.com/fog/fog-local.svg)](https://gemnasium.com/fog/fog-local)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'fog-local'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install fog-local

## Usage

Initialise a `Fog::Local::Storage` object:

```ruby
storage = Fog::Local::Storage.new(local_root: '~/fog')
```

This can then be used like any other [Fog storage](http://fog.io/storage/).

```ruby
directory = storage.directories.create(key: 'data')
directory.files.create(body: 'Hello World!', key: 'hello_world.txt')
```

## Contributing

1. Fork it ( https://github.com/fog/fog-local/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request