Merge pull request #1 from ts-klassen/main

Initial implementation

.github/workflows/erlang.yml

@@ -0,0 +1,54 @@
+name: Erlang CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+
+  erlang24:
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: erlang:24
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Compile
+      run: rebar3 compile
+    - name: Run tests
+      run: rebar3 do eunit, ct
+
+  erlang25:
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: erlang:25
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Compile
+      run: rebar3 compile
+    - name: Run tests
+      run: rebar3 do eunit, ct
+
+  erlang26:
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: erlang:26
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Compile
+      run: rebar3 compile
+    - name: Run tests
+      run: rebar3 do eunit, ct

.gitignore

@@ -0,0 +1,19 @@
+.rebar3
+_*
+.eunit
+*.o
+*.beam
+*.plt
+*.swp
+*.swo
+.erlang.cookie
+ebin
+log
+erl_crash.dump
+.rebar
+logs
+_build
+.idea
+*.iml
+rebar3.crashdump
+*~

CHANGELOG.md

@@ -1,3 +1,5 @@
 # CHANGELOG
 
-@todo
+## UNRELEASED 0.1.0
+### New Feature
+- Initial implementation

README.md

@@ -4,11 +4,34 @@ Sqids (pronounced "squids") is a small library that lets you generate YouTube-lo
 
 ## Getting started
 
-@todo
+Add sqids as a dependency to rebar.config
+<!-- FIXME: 0.1.0 is unreleased. -->
+```erlang
+{deps,
+    [
+        {sqids, {git, "https://github.com/sqids/sqids-erlang.git",  {tag, "0.1.0"}}}
+    ]
+}.
+```
+Supported Erlang versions are 
+  - Erlang/OTP 24
+  - Erlang/OTP 25
+  - Erlang/OTP 26
 
 ## Examples
 
-@todo
+```erlang
+1> Sqids = sqids:new(),
+1> Id = sqids:encode([1, 2, 3], Sqids).
+<<"86Rf07">>
+2> sqids:decode(Id, Sqids).
+[1,2,3]
+3> MySqids = sqids:new(#{alphabet=><<"ABC123">>, min_length=>10, blocklist=>[]}),
+3> MyId = sqids:encode([0], MySqids).
+<<"A13C2B31AC">>
+4> sqids:decode(MyId, MySqids).
+[0]
+```
 
 ## License
 

rebar.config

@@ -0,0 +1,2 @@
+{erl_opts, [debug_info]}.
+{deps, []}.

rebar.lock

@@ -0,0 +1 @@
+[].

src/sqids.app.src

@@ -0,0 +1,14 @@
+{application, sqids,
+ [{description, "An OTP library"},
+  {vsn, "0.1.0"},
+  {registered, []},
+  {applications,
+   [kernel,
+    stdlib
+   ]},
+  {env,[]},
+  {modules, []},
+
+  {licenses, ["MIT License"]},
+  {links, []}
+ ]}.