From 24a1054350ac5bd89237642279eacc912cf2e247 Mon Sep 17 00:00:00 2001
From: mob-sakai <sakai@mobcast.jp>
Date: Tue, 21 Jan 2020 12:41:42 +0900
Subject: [PATCH] docs: add documents

---
 .github/FUNDING.yml | 12 ++++++++++++
 README.md           | 48 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)
 create mode 100644 .github/FUNDING.yml

diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000000000..b8d00370cac86
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: mob-sakai # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: mob_sakai # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
diff --git a/README.md b/README.md
index 797696ee1dcd9..a125409cd7385 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,51 @@
+## Open Sesame Compiler
+
+[![Nuget](https://img.shields.io/nuget/v/OpenSesameCompiler)](https://www.nuget.org/packages/OpenSesameCompiler)
+![GitHub](https://img.shields.io/github/license/mob-sakai/OpenSesameCompiler)
+![dl](https://img.shields.io/nuget/dt/OpenSesameCompiler)
+![ci](https://github.com/mob-sakai/OpenSesameCompiler/workflows/Release/badge.svg)
+
+> _Then Ali Baba climbed down and went to the door concealed among the bushes, and said, "Open, Sesame!" and it flew open._
+
+This compiler is a rebuild of [Roslyn compiler](https://www.nuget.org/packages/Microsoft.Net.Compilers).
+
+This compiler allows access to internals/privates in other assemblies.
+
+#### Changes from original
+
+* Change package name to `OpenSesameCompiler`
+* Allow unsafe code automatically
+* Add `MetadataImportOptions.All` to compilation options
+* All public static methods in `AccessCheck` class will return `true`
+
+#### ~~How to run (demo)~~
+
+1. ~~Clone [demo project]()~~
+```sh
+git clone demo-proj
+cd demo-proj
+```
+2. ~~The compilation will fail because this project contains internals/privates access.~~
+```sh
+# The following command will fail.
+dotnet run
+```
+```sh
+```
+3. ~~Install `OpenSesameCompiler` package to project from nuget~~
+```sh
+dotnet add OpenSesameCompiler
+```
+4. ~~Add `<CscToolPath>$(PkgOpenSesameCompiler)tools/csc.exe</CscToolPath>` to `PropertyGroup` in `demo.csproj`.~~  
+~~Or, execute the following command.~~
+```sh
+dotnet run /p:CscToolPath=$(PkgOpenSesameCompiler)tools/csc.exe
+```
+5. ~~Enjoy!~~
+
+
+<br><br><br><br><br><br>
+
 ## Welcome to the .NET Compiler Platform ("Roslyn")
 
 [//]: # (Begin current test results)