Skip to content

#1 add basic README.md #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 20, 2024
Merged

#1 add basic README.md #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,30 @@
# readable-ids

The readable-ids library makes it possible to generate IDs that are easy for humans to read. It is based on dictionaries
that can either be created individually or selected from a supplied selection of different dictionaries. The library
offers various modifications and merging strategies that can be customized or created for specific applications. This
allows developers to create flexible and user-friendly IDs that are both easy to read and easy to remember.

## Usage

### Add the dependency to your project

**Gradle**

```gradle
implementation 'de.adrianlange:readable-ids-core:VERSION'
```

**Maven**

```xml
<dependency>
<groupId>de.adrianlange</groupId>
<artifactId>readable-ids-core</artifactId>
<version>VERSION</version>
</dependency>
```

## Changelog

A list of changes can be found under [Changelog.md](Changelog.md).