Add README.md and update interfaces

Author: pikinier20

README.md

@@ -0,0 +1,55 @@
+# CS Demo Parser
+
+CS Demo Parser is a Scala library for retrieving information from CS:GO .dem files.
+
+## Usage
+CS Demo Parser exhibits interface to use it from Scala and Java.
+Java:
+```java
+//Obtain parser interface by call
+DemoParserInterface parser = DemoParsing.getParser();
+
+//Parser API
+public interface DemoParserInterface {
+    Future<DemoInterface> parseFromPath(Path path, ParserConfigInterface config, ExecutorService exService);
+    Future<DemoInterface> parseFromInputStream(InputStream input, ParserConfigInterface config, ExecutorService exService);
+}
+//Future will throw DemoParsingException(String reason) on error
+
+//For ParserConfigInterface you can use JavaParserConfig
+class JavaParserConfig {
+    public JavaParserConfig(Set<String> _ignoredGameEvents);
+}
+```
+Scala:
+```scala
+//Use DemoParser companion object for parsing demos
+object DemoParser {
+  def parseFromPath(path: Path, config: ParserConfigInterface)(implicit ec: ExecutionContext): Future[Either[String, Demo]]
+  def parseFromInputStream(inputStream: InputStream, config: ParserConfigInterface)(implicit ec: ExecutionContext): Future[Either[String, Demo]]
+}
+//Instead of throwing exception it returns Either[String, Demo]
+
+//Instead of interfaces you can use model implemented with case classes
+case class Demo(header: Header, events: Seq[GameEvent])
+case class Header(/*...*/)
+case class GameEvent(name: String, tick: Int, keys: Map[String, Value[_]])
+sealed trait Value[T]
+
+//For config you can use ParserConfig case class
+case class ParserConfig(ignoredGameEvents: Set[String])
+```
+
+Model classes also implement `PrettyPrintable` and `JsonSerializable` interfaces.
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## Credits
+Parsing algorithm used in this project was taken from [demofile](https://github.com/saul/demofile).
+
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)

src/main/java/DemoParsing.java

@@ -0,0 +1,10 @@
+package demoparser;
+
+import demoparser.interfaces.DemoParserInterface;
+import demoparser.parser.DemoParser$;
+
+public class DemoParsing {
+    public static DemoParserInterface getParser() {
+        return DemoParser$.MODULE$;
+    }
+}

src/main/java/interfaces/DemoInterface.java

@@ -4,7 +4,7 @@
 
 import java.util.List;
 
-public interface DemoInterface {
+public interface DemoInterface extends PrettyPrintable, JsonSerializable {
     HeaderInterface header();
     List<GameEventInterface> eventsList();
 }

src/main/java/interfaces/GameEventInterface.java

@@ -4,7 +4,7 @@
 
 import java.util.Map;
 
-public interface GameEventInterface {
+public interface GameEventInterface extends PrettyPrintable, JsonSerializable {
     String name();
     int tick();
     Map<String, ValueInterface<?>> keysMap();

src/main/java/interfaces/HeaderInterface.java

@@ -1,6 +1,6 @@
 package demoparser.interfaces;
 
-public interface HeaderInterface {
+public interface HeaderInterface extends PrettyPrintable, JsonSerializable {
     String magic();
     int protocol();
     int networkProtocol();

src/main/java/interfaces/JsonSerializable.java

@@ -0,0 +1,5 @@
+package demoparser.interfaces;
+
+public interface JsonSerializable {
+    String toJson();
+}

src/main/java/interfaces/PrettyPrintable.java

@@ -0,0 +1,5 @@
+package demoparser.interfaces;
+
+public interface PrettyPrintable {
+    String prettyPrint();
+}

src/main/java/interfaces/ValueInterface.java

@@ -1,5 +1,5 @@
 package demoparser.interfaces;
 
-public interface ValueInterface<T> {
+public interface ValueInterface<T> extends PrettyPrintable, JsonSerializable {
     public T v();
 }

src/main/scala/Main.scala

@@ -3,7 +3,6 @@ package demoparser
 import parser.DemoParser
 
 import demoparser.config.ParserConfig
-import demoparser.serialization.JsonDemoSerializer
 
 import java.io.{File, FileOutputStream, PrintStream}
 import java.nio.file.{Files, Paths}
@@ -22,7 +21,7 @@ object Main extends App {
   val ps = new PrintStream(fileOS)
   val json =
     demo.map(
-      _.fold(s => println(s), d => ps.print(JsonDemoSerializer.serialize(d)))
+      _.fold(s => println(s), d => ps.print(d.toJson))
     )
   val eventStats = demo.map(
     _.map(

src/main/scala/model/Demo.scala

@@ -2,15 +2,21 @@ package demoparser
 package model
 
 import interfaces.{DemoInterface, GameEventInterface}
+
+import demoparser.serialization.JsonDemoSerializer
+
 import scala.collection.JavaConverters._
 
-case class Demo(header: Header, events: Seq[GameEvent])
-    extends PrettyPrintable
-    with DemoInterface {
+case class Demo(header: Header, events: Seq[GameEvent]) extends DemoInterface {
   override def prettyPrint: String =
     header.prettyPrint + "\n" + events.map(_.prettyPrint).mkString("\n")
   override def eventsList(): java.util.List[GameEventInterface] = {
     val e: Seq[GameEventInterface] = events
     e.asJava
   }
+
+  override def toJson: String = {
+    import io.circe.generic.auto._
+    JsonDemoSerializer.serializeIfPossible(this)
+  }
 }