README.md added

README.md

@@ -0,0 +1,29 @@
+# libc0ding
+
+## Shared library for standardized functionality in c0ding projects
+
+### Requirements
+
+- build tool:
+  - `cmake >= 3.15.0`
+- compiler:
+  - `gcc >= 9.2.0`
+  - `clang >= 9.0.0`
+
+### Current features
+
+- `c0ding::string` library (complements `std::string`) with additional features
+  - `erase_line` - tries to erase the first line of the string which contains the sequence
+  - `get_from` - get the part of the string after the given delimiter (exclusive)
+  - `get_until` - get the part of the string before the given delimiter (exclusive)
+  - `replace` - replace all occurrences of the given value found in the string by the given replacement inplace
+  - `split` - split the string at the given delimiter
+  - `to_lower` - transform all characters in the string to lowercase
+  - `to_upper` - transform all characters in the string to uppercase
+
+### Currently planned features
+
+- `c0ding::networking` library (based on `boost::asio`)
+- `c0ding::algorithm` library
+  - `c0ding::algorithm::sort` algorithms
+  - `c0ding::algorithm::search` algorithms