Skip to content

Commit

Permalink
tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
webNeat committed Jun 25, 2016
1 parent bab7333 commit 26a23e6
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2015 Amine Ben hammou <webneat@gmail.com>
Copyright (c) 2016 Amine Ben hammou <webneat@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ A tool to encode and decode strings based on flexible and composable syntax defi

- [Step by Step Guide](#step-by-step-guide)

- [Parsing and Dumping Strings](#parsing-and-dumping-strings)

- [Parsing and Dumping Numbers](#parsing-and-dumping-numbers)

- [Parsing and Dumping Booleans](#parsing-and-dumping-booleans)

- [Parsing and Dumping Arrays](#parsing-and-dumping-arrays)

- [Parsing and Dumping Objects](#parsing-and-dumping-objects)

- [Using the Factory](#using-the-factory)

- [Write Your Own Syntax Definition](#write-your-own-syntax-definition)

- [Next Steps](#next-steps)

- [Development Notes](#development-notes)
Expand Down Expand Up @@ -339,6 +353,10 @@ $syntax = S::arr(...); // $syntax = new ArraySyntax(...);
$syntax = S::obj(...); // $syntax = new ObjectSyntax(...);
```

## Write Your Own Syntax Definition

To write your own custom syntax class, you just need to inherit from [`Syntax`](https://github.com/tarsana/syntax/blob/master/docs/Syntax.md) and implement the missing methods.

# Next Steps

- Define syntaxes using JSON or YAML files.
Expand Down

0 comments on commit 26a23e6

Please sign in to comment.