add readme

chengchingwen · Jan 10, 2022 · 8c12202 · 8c12202
1 parent 8fb89a1
commit 8c12202
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,3 +4,7 @@
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://chengchingwen.github.io/TextEncodeBase.jl/dev)
 [![Build Status](https://github.com/chengchingwen/TextEncodeBase.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/chengchingwen/TextEncodeBase.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/chengchingwen/TextEncodeBase.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/chengchingwen/TextEncodeBase.jl)
+
+
+An api for encoding text, built on top of [WordTokenizers.jl](https://github.com/JuliaText/WordTokenizers.jl).
+ Providing a framework to easily define custom methods to convert strings into indices.