Update README.md

This commit is contained in:
Booklordofthedings 2024-08-26 13:29:32 +02:00
parent 8d042baf85
commit 08c518d5dc

View file

@ -1,4 +1,4 @@
# Bofa - Books Object Format A # Bofa - Books Object Format A - 1.0.0
Bofa is an object notation for general purpose use in serialization and deserialization. Bofa is an object notation for general purpose use in serialization and deserialization.
The primary focus is on being human readable, while also being extremely easy to parse The primary focus is on being human readable, while also being extremely easy to parse
This repository implements a Bofa parser in the Beef programming language. This repository implements a Bofa parser in the Beef programming language.
@ -16,6 +16,7 @@ a Array
## Index ## Index
- How to install - How to install
- Changelog
- The Bofa notation - The Bofa notation
- Parser notes - Parser notes
- Bofa parser API usage - Bofa parser API usage
@ -33,6 +34,12 @@ a Array
- Add the Bofa namespace to the files you want to use Bofa with - Add the Bofa namespace to the files you want to use Bofa with
- Use Bofa - Use Bofa
## Changelog
- Version 1.0.0
- Initial Version
- Fast parsing
- Add automated serialization generation
## The Bofa notation ## The Bofa notation
The notation itself is pretty simple. The notation itself is pretty simple.
Every line contains one Bofa "Entry", but empty lines and comments are also allowed. Every line contains one Bofa "Entry", but empty lines and comments are also allowed.