Add readme and license

LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2020-present Shyim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,42 @@
+# Admin Node-API Client for Shopware 6
+
+This code highly bases on the [Administration Code](https://github.com/shopware/platform/tree/745f1f7aaa5c47d123e04b5b5b93b81161eae19a/src/Administration/Resources/app/administration/src/core/data-new) and made NodeJs compatible.
+
+## Creation of API Client
+
+### Using Username and Password
+
+```js
+import {createFromPasswordAndLogin} from 'shopware-admin-api';
+
+let api = await createFromPasswordAndLogin('http://myshop.com', 'username', 'password', 1);
+```
+
+### Using Integration
+
+```js
+import {createFromIntegration} from 'shopware-admin-api';
+
+let api = await createFromIntegration('http://myshop.com', 'client_id', 'client_secret', 1);
+```
+
+
+## Usage
+
+```js
+// Create repository
+const productRepository = api.create('product');
+
+// Access default context
+const context = api.defaultContext();
+
+// Acccess entity definition (contains the schema, required fields etc.)
+const definition = api.EntityDefinition;
+
+console.log(definition.get('product'))
+console.log(definition.getRequiredFields('product'))
+```
+
+## License
+
+[MIT](LICENSE.md)

example/definition.js

@@ -0,0 +1,10 @@
+import {createFromPasswordAndLogin} from '../src/index.js';
+
+async function test()
+{
+    let api = await createFromPasswordAndLogin('<url>', 'demo', 'demo', 1);
+
+    console.log(api.EntityDefinition.getRequiredFields('product'));
+} 
+
+test();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "shopware-admin-api",
-  "version": "0.1.0",
+  "version": "0.0.1",
   "description": "Shopware API",
   "main": "index.js",
   "type": "module",