Add README.md

Author: brendanator

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/sourcery-ai/sourcery
+    rev: v0.9.4
+    hooks:
+      - id: sourcery

README.md

@@ -0,0 +1,14 @@
+# Sourcery examples
+
+Try out Sourcery functionality using the examples in this repo
+
+### Setup
+
+1. [Sign up](https://sourcery.ai/signup/) and [install](https://sourcery.ai/dashboard/install) Sourcery in your IDE or code editor
+2. Clone this repo and open in your IDE
+
+### Trying it out
+
+- Refactoring examples are in the `refactorings` directory
+- Try out *Sourcery - scan for refactorings* on the `refactorings/scan` folder
+- Try out *Sourcery - detect clones* on the `clones` folder