<commit_before># Godmin

[![Gem Version](https://badge.fury.io/rb/godmin.svg)](http://badge.fury.io/rb/godmin)
[![Build Status](https://travis-ci.org/varvet/godmin.svg?branch=master)](https://travis-ci.org/varvet/godmin)
[![Code Climate](https://codeclimate.com/github/varvet/godmin/badges/gpa.svg)](https://codeclimate.com/github/varvet/godmin)

Godmin is an admin engine for Rails 4+.

- [Installation](#installation)
	- [Standalone installation](#standalone-installation)
	- [Engine installation](#engine-installation)
	- [Installation artefacts](#installation-artefacts)
- [Getting started](#getting-started)
- [Controllers](#controllers)
	- [Scopes](#scopes)
	- [Filters](#filters)
	- [Batch actions](#batch-actions)
	- [Resource fetching](#resource-fetching)
- [Views](#views)
- [Models](#models)
- [Authentication](#authentication)
	- [Simple authentication](#simple-authentication)
	- [Shared authentication](#shared-authentication)
- [Authorization](#authorization)
- [Localization](#localization)
- [Contributors](#contributors)

## Installation

Godmin supports two common admin scenarios:

1. Standalone installation
2. Engine installation

### Standalone installation
Use for admin-only applications, or for architectures where the admin lives in its own app. Typically, you want to access the admin section at `localhost:3000`.

Add the gem to the application's `Gemfile`:
```ruby
gem "godmin"
```

Run the install generator:
```sh
$ bin/rails generate godmin:install
```

Godmin should be up and running at `localhost:3000`
<commit_msg>Updates README.md<commit_after># Godmin

[![Gem Version](https://badge.fury.io/rb/godmin.svg)](http://badge.fury.io/rb/godmin)
[![Build Status](https://travis-ci.org/varvet/godmin.svg?branch=master)](https://travis-ci.org/varvet/godmin)
[![Code Climate](https://codeclimate.com/github/varvet/godmin/badges/gpa.svg)](https://codeclimate.com/github/varvet/godmin)

Godmin is an admin engine for Rails 4+.

- [Installation](#installation)
	- [Standalone installation](#standalone-installation)
	- [Engine installation](#engine-installation)
	- [Installation artefacts](#installation-artefacts)
- [Getting started](#getting-started)
- [Controllers](#controllers)
	- [Scopes](#scopes)
	- [Filters](#filters)
	- [Batch actions](#batch-actions)
	- [Resource fetching](#resource-fetching)
- [Views](#views)
- [Models](#models)
- [Authentication](#authentication)
	- [Simple authentication](#simple-authentication)
	- [Shared authentication](#shared-authentication)
- [Authorization](#authorization)
- [Localization](#localization)
- [Contributors](#contributors)
- [License](#license)

## Installation

Godmin supports two common admin scenarios:

1. Standalone installation
2. Engine installation

### Standalone installation
Use for admin-only applications, or for architectures where the admin lives in its own app. Typically, you want to access the admin section at `localhost:3000`.

Add the gem to the application's `Gemfile`:
```ruby
gem "godmin"
```

Run the install generator:
```sh
$ bin/rails generate godmin:install
```

Godmin should be up and running at `localhost:3000`

{'fraction_non_alphanumeric': 0.15505115089514065, 'fraction_numerical': 0.007033248081841432, 'mean_word_length': 5.892070484581498, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, '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': '3446891', 'n_tokens_mistral': 1042, 'n_tokens_neox': 958, 'n_words': 218}