<commit_before>Backup
======

Backup is a system utility for Linux and Mac OS X, distributed as a RubyGem, that allows you to easily perform backup
operations. It provides an elegant DSL in Ruby for _modeling_ your backups. Backup has built-in support for various
databases, storage protocols/services, syncers, compressors, encryptors and notifiers which you can mix and match. It
was built with modularity, extensibility and simplicity in mind.

## Installation

To get the latest stable version:

    gem install backup

See [Release Notes](https://github.com/meskyanichi/backup/wiki/Release-Notes) in the wiki for changes in the latest
version.

Backup supports Ruby versions 1.8.7, 1.9.2, 1.9.3 and 2.0.0.

## Overview

Backup allows you to _model_ your backup jobs using a Ruby DSL:

```rb
Backup::Model.new(:my_backup, 'Description for my_backup') do
  # ... components here ...
end
```

The `:my_backup` symbol is the model's `trigger` and used to perform the job:

    $ backup perform --trigger my_backup

Backup's _components_ are added to the backup _model_ to define the actions to be performed.  
All of Backup's components are fully documented in the [Backup Wiki](https://github.com/meskyanichi/backup/wiki).  
The following is brief overview of the components Backup provides:
<commit_msg>update installation instructions<commit_after>Backup
======

Backup is a system utility for Linux and Mac OS X, distributed as a RubyGem, that allows you to easily perform backup
operations. It provides an elegant DSL in Ruby for _modeling_ your backups. Backup has built-in support for various
databases, storage protocols/services, syncers, compressors, encryptors and notifiers which you can mix and match. It
was built with modularity, extensibility and simplicity in mind.

## Installation

To install the latest version, run:

    $ [sudo] gem install backup

_Do not add `gem backup` to an application's `Gemfile`_

See [Installation](https://github.com/meskyanichi/backup/wiki/Installation) for more information about installing and
updating your installation of Backup.

See [Release Notes](https://github.com/meskyanichi/backup/wiki/Release-Notes) for changes in the latest version.

Backup supports Ruby versions 1.8.7, 1.9.2, 1.9.3 and 2.0.0.

## Overview

Backup allows you to _model_ your backup jobs using a Ruby DSL:

```rb
Backup::Model.new(:my_backup, 'Description for my_backup') do
  # ... components here ...
end
```

The `:my_backup` symbol is the model's `trigger` and used to perform the job:

    $ backup perform --trigger my_backup

Backup's _components_ are added to the backup _model_ to define the actions to be performed.  
All of Backup's components are fully documented in the [Backup Wiki](https://github.com/meskyanichi/backup/wiki).  
The following is brief overview of the components Backup provides:

{'fraction_non_alphanumeric': 0.07876230661040788, 'fraction_numerical': 0.008438818565400843, 'mean_word_length': 4.408745247148289, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 5, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4054662', 'n_tokens_mistral': 816, 'n_tokens_neox': 787, 'n_words': 364}