From 775a12f591a8bd9dbfa46f56c877c1bc3449f3ba Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Farkas=20M=C3=A1t=C3=A9?= <f.mate1128@gmail.com>
Date: Sun, 14 Jan 2024 15:24:30 +0100
Subject: [PATCH] Create README.md

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c42a3db
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Frick.NET
+
+## What is this?
+This is a simple [Brainfuck](https://github.com/sunjay/brainfuck/blob/master/brainfuck.md) interpreter written in .NET. It's not the first, certainly not the best, but it's mine.
+
+## Why?
+I was bored.
+
+## How do I use it?
+You can use Frick.NET in two ways: consume it as a class library or use the CLI.
+
+### Using the class library:
+```csharp
+using Frick.NET; 
+
+string source = "<your Brainfuck code goes here>";
+FrickInterpreter interpreter = new();
+interpreter.Run(source);
+```
+
+### Using the CLI:
+1. Build the CLI from source or download it from the Releases tab.
+2. You can pass Brainfuck code in the following ways:
+   * Pass a file name as an argument: `frick-cli -i <FILENAME>`
+   * Pass a file's content piped from STDIN: `'<Brainfuck goes here>' > frick-cli`
+   * Run `frick-cli` without any arguments and enter the code using the terminal