path: root/README.md
diff options
Diffstat (limited to 'README.md')
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2d00a68
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Config::Parser::toml
+A TOML parser for [Config](https://git.tyil.nl/raku/config).
+## Installation
+zef install Config::Parser::toml
+## Known issues
+- The dependency `Config::TOML` fails to test on Rakudo 2017.03. As such,
+ you will need to use Rakudo 2017.04 or higher in order to use this module.
+## License
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU Affero General Public License as published by the Free
+Software Foundation, either version 3 of the License, or (at your option) any
+later version.
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+You should have received a copy of the GNU Affero General Public License along
+with this program. If not, see <https://www.gnu.org/licenses/>.