Skip to content

Add limitations section to readme. #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xoac wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add limitations section to readme. #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# GoodForm
Form validation library. Includes MsgPack and JSON serializer/deserializer.

#MsgPack Usage
## MsgPack Usage
```c++
std::stringstream ss;
goodform::variant var, var2;
Expand Down Expand Up @@ -30,8 +30,9 @@ if (form.is_good())
std::cout << "{ \"compact\": " << std::boolalpha << mpack.compact << ", \"schema\": " << mpack.schema << " }" << std::endl;
}
```
- - - -

#JSON Usage
## JSON Usage
```c++
goodform::variant var;
std::stringstream ss;
Expand Down Expand Up @@ -83,4 +84,6 @@ else
{
// Handle error.
}
```
```
## Limitations
- complex keys are out of scope with this library (key can be only strings in msgpack)