Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jagrosh authored Nov 17, 2016
1 parent 818f1a6 commit cf7d8ca
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## JagTag
JagTag is a simple - yet powerful and customizable - interpretted text parsing language!
Some methods are included in the built-in libraries, and additional methods can be defined that utilize the parser environment veriables, as well as the method's input.

## Simple Example
```java
import me.jagrosh.jagtag.*;
public class Example
{
public static void main(String[] args)
{
Parser parser = JagTag.newDefaultBuilder()
.addMethod( new Method("exclaim", (env,in) -> in[0]+"!!!") )
.build();
String result = parser.parse("{exclaim:{if:this|=|that|then:Foo Bar|else:Hello World}}");
System.out.println(result);
}
}
```
Result: `Hello World!!!`

## Current Projects
Here are some other projects that utilize JagTag:
* [**Spectra (Discord Bot)**](https://github.com/jagrosh/Spectra) - Spectra uses JagTag in its customizable "tags" (user-created commands), and in welcome and leave messages for servers. (https://github.com/jagrosh/Spectra/blob/master/src/spectra/jagtag/libraries/Discord.java)

0 comments on commit cf7d8ca

Please sign in to comment.