<commit_before>Contargo Types
===============

This is a library aimed at providing a collection of re-usable Contargo objects.

## Getting started

Using the `contargo-types` as a library in your project, means simply including
it as a Maven dependency:

    <dependency>
      <groupId>net.contargo</groupId>
      <artifactId>contargo-types</artifactId>
      <version>LATEST</version>
    </dependency>

## Development

This is a pretty straight-forward Java-project, use `mvn` to build, test and
deploy.

Happy hacking!<commit_msg>Update README: add container number and license plate examples<commit_after>Contargo Types
===============

This is a library aimed at providing a collection of re-usable Contargo objects.

## Getting started

Using the `contargo-types` as a library in your project, means simply including
it as a Maven dependency:

```xml
<dependency>
    <groupId>net.contargo</groupId>
    <artifactId>contargo-types</artifactId>
    <version>LATEST</version>
</dependency>
```

## Usage

### Container number

```java
ContainerNumber containerNumber = ContainerNumber.forValue(string);
```

The built container number instance provides various information, such as the
validity on `isValid()` or the formatted value on `toString()`.

### License plate

```java
// Create with default country Germany
LicensePlate licensePlate = LicensePlate.forValue(string);
// Create with dedicated country
LicensePlate licensePlateWithCountry = LicensePlate.forValue(string).withCountry(SupportedLicensePlateCountry.NETHERLANDS);
```

The built license plate instance provides various information depending on the
bound country, such as the validity on `isValid()` or the formatted value on
`toString()`.

To find out which countries are supported, take a look at the
`SupportedLicensePlateCountry` enum.

## Development

This is a pretty straight-forward Java-project, use `mvn` to build, test and
deploy.

Happy hacking!
{'fraction_non_alphanumeric': 0.09937888198757763, 'fraction_numerical': 0.0, 'mean_word_length': 5.136507936507937, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 1}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3123376', 'n_tokens_mistral': 538, 'n_tokens_neox': 499, 'n_words': 202}