add license, readme

README.md

@@ -0,0 +1,43 @@
+# Sapphirecode ESLint configuration
+
+Javascript coding standard used by Sapphirecode
+
+## Installation
+
+to install this module you have to add the following line to your .npmrc
+
+```npmrc
+@scode:registry=https://npm.scode.ovh
+```
+
+then install the module and eslint
+
+```sh
+npm i --save-dev @scode/eslint-config eslint
+```
+
+then create a file named .eslintrc.js with the following contents.
+
+it is a basic configuration, it can be customized to your preferences.
+
+```js
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true
+  },
+  extends: [
+    '@scode'
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly'
+  },
+  parserOptions: {
+    ecmaVersion: 2018
+  }
+}
+```
+  
+after that you can run eslint.

index.js

@@ -1,3 +1,10 @@
+/*
+ * Copyright (C) Sapphirecode - All Rights Reserved
+ * This file is part of @scode/eslint-config which is released under BSD-3-Clause.
+ * See file 'LICENSE' for full license details.
+ * Created by Timo Hocker <timo@scode.ovh>, January 2020
+ */
+
 module.exports = {
 
   globals: {},