Update README.md Project description
diff --git a/README.md b/README.md index f604a95..9b4fa84 100644 --- a/README.md +++ b/README.md
@@ -1,11 +1,10 @@ -# Caravel encoder +# Caravel Multi encoder [](https://opensource.org/licenses/Apache-2.0) [](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml) [](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_build.yml) -| :exclamation: Important Note | -|-----------------------------------------| - -## Please fill in your project documentation in this README.md file +Refer to [README](docs/source/index.rst) for the project compilation. -Refer to [README](docs/source/index.rst) for this sample project documentation. +This work is an integrated multi purpouse encoder design which can simultaneously get two 32-bit data and key of 32-bit size for generating 32-bit encoded data. Those two 32-bit data may belong to the same process in case of data encryption(64-bit parallel encryption can be done) and it can be from different processes in case of signal processing applications to establish authentication. + +The encoder design is integrated with caravel. Inputs for the encoder can be fed from caravel management area through LA and output can also be read from LA.