Create project

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6b3a8c2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+## PGNP: PGN Parser
+
+PGNP is a Portable Game Notation (PGN) parser. More details about the
+PGN specification can be found [here](https://www.chessclub.com/help/PGN-spec).
+
+# How to use it ?
+PGNP can be used as a shared library in your project.
+You only need to include the header file and linking the .so file to your
+executable.
+
+# Example
+Load PGN from file:
+
+    pgnp::PGN pgn;
+    try {
+        pgn.FromFile("pgn.txt");
+    }
+    catch(...){
+        // Handle exceptions
+    }
+Load PGN from string:
+
+    pgnp::PGN pgn;
+    try {
+        pgn.FromString("YOUR PGN CONTENT HERE");
+    }
+    catch(...){
+        // Handle exceptions
+    }
+
+// TODO: How to use the PGN object with the parsed data
\ No newline at end of file