<commit_before>MIG: Mozilla InvestiGator
=========================
<img style="float: right" src="doc/.files/MIG-logo-CC-small.jpg" size="300px">

[![Build Status](https://travis-ci.org/mozilla/mig.svg?branch=master)](https://travis-ci.org/mozilla/mig)

MIG is Mozilla's platform for investigative surgery of remote endpoints.

Quick Start w/ Docker
---------------------

You can spin up a local-only MIG setup using docker. The container is not suitable for production use but
lets you experiment with MIG quickly, providing a single container environment that has most of the MIG components
available.

To pull from Docker Hub:

```bash
$ docker pull mozilla/mig
$ docker run -it mozilla/mig
```

Or, if you have the source checked out in your GOPATH you can build your own image:

```bash
$ cd $GOPATH/src/github.com/mozilla/mig<commit_msg>Add a notice of deprecation to the README<commit_after>MIG: Mozilla InvestiGator
=========================
<img style="float: right" src="doc/.files/MIG-logo-CC-small.jpg" size="300px">

MIG is Mozilla's platform for investigative surgery of remote endpoints.

⚠️ Deprecation Notice ⚠️
-------------------------

Mozilla is no longer maintaining thie Mozilla InvestiGator (MIG) project.

Mozilla is also no longer making use of this code internally.

You are welcome to use this code as is with no warranty.

If you would like to take or transfer ownership of this project, please let us know first by opening an issue.

Quick Start w/ Docker
---------------------

You can spin up a local-only MIG setup using docker. The container is not suitable for production use but
lets you experiment with MIG quickly, providing a single container environment that has most of the MIG components
available.

To pull from Docker Hub:

```bash
$ docker pull mozilla/mig
$ docker run -it mozilla/mig
```

Or, if you have the source checked out in your GOPATH you can build your own image:

```bash
$ cd $GOPATH/src/github.com/mozilla/mig
{'fraction_non_alphanumeric': 0.13306246825799897, 'fraction_numerical': 0.0030472320975114273, 'mean_word_length': 3.8166259168704157, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, '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': '1932229', 'n_tokens_mistral': 596, 'n_tokens_neox': 552, 'n_words': 252}