<commit_before>Instalation
===========

```bash
gem install slugity
```

or with bundler
```ruby
gem 'slugity'
```

Use
===

To use Slugity, require it and then include the module where needed. So:
```ruby
require 'slugity'
include Slugity
```
then gives you access to the `slugity` method. The `slugity` method takes a string and returns a slug.

To include the `to_slug` method on the `String` class
```ruby
require 'slugity/extend_string'
```

Examples
========

```ruby
require 'slugity'
include Slugity

slugity "hello world"
# => hello-world

slugity "one & one"
# => one-and-one
```

```ruby
require 'slugity/extend_string'

"hello world".to_slug
# => hello-world

"one & one".to_slug
# => one-and-one


Testing
=======

```bash
$ bundle install
# => installs the testing gems

$ autotest
# => runs the specs
```


Contributing
============

If there is any thing you'd like to contribute or fix, please:

- Fork the repo<commit_msg>close fence in readme<commit_after>Instalation
===========

```bash
gem install slugity
```

or with bundler
```ruby
gem 'slugity'
```

Use
===

To use Slugity, require it and then include the module where needed. So:
```ruby
require 'slugity'
include Slugity
```
then gives you access to the `slugity` method. The `slugity` method takes a string and returns a slug.

To include the `to_slug` method on the `String` class
```ruby
require 'slugity/extend_string'
```

Examples
========

```ruby
require 'slugity'
include Slugity

slugity "hello world"
# => hello-world

slugity "one & one"
# => one-and-one
```

```ruby
require 'slugity/extend_string'

"hello world".to_slug
# => hello-world

"one & one".to_slug
# => one-and-one
```

Testing
=======

```bash
$ bundle install
# => installs the testing gems

$ autotest
# => runs the specs
```


Contributing
============

If there is any thing you'd like to contribute or fix, please:

- Fork the repo
{'fraction_non_alphanumeric': 0.16023268112109995, 'fraction_numerical': 0.0, 'mean_word_length': 4.436781609195402, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 15, 'https://': 0, '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': '1809650', 'n_tokens_mistral': 685, 'n_tokens_neox': 644, 'n_words': 224}