Răsfoiți Sursa

docs: Add MIT license, expand readme

Michael Bromley 7 ani în urmă
părinte
comite
5919ce67da
5 a modificat fișierele cu 50 adăugiri și 4 ștergeri
  1. 11 1
      CONTRIBUTING.md
  2. 9 0
      LICENSE
  3. 29 1
      README.md
  4. 0 1
      server/LICENSE.md
  5. 1 1
      server/package.json

+ 11 - 1
CONTRIBUTING.md

@@ -1,3 +1,13 @@
+# Contribution Guidelines
+
+## Note: code contributions discouraged in pre-alpha phase
+
+Due to the very early phase of this project, significant changes to code and architecture are still taking place.
+
+Therefore I do not recommend investing time in making code changes until things are more stable.
+
+Contributions in terms of suggestions or other relevant feedback are welcome.
+
 ### Commit message format
 Ref: [Karma commit message conventions](http://karma-runner.github.io/0.10/dev/git-commit-msg.html)
 ```
@@ -12,4 +22,4 @@ type(scope): Message in present tense
 * **test** (adding missing tests, refactoring tests; no production code change)
 * **chore** (updating build tasks etc; no production code change)
 
-`scope` indicates the module affected (server, admin-ui, docs etc.)
+`scope` indicates the module affected (server, admin-ui, docs etc.)

+ 9 - 0
LICENSE

@@ -0,0 +1,9 @@
+The MIT License
+
+Copyright (c) 2018 Michael Bromley
+
+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.

+ 29 - 1
README.md

@@ -1,5 +1,33 @@
 # Vendure
 
+![logo](admin-ui/src/assets/cube-logo-300px.png)
+
 A headless ecommerce framework built on TypeScript, Node & GraphQL.
 
-Currently under initial development. Nothing much to see for now.
+### Status
+
+Currently in pre-alpha, i.e. it is not yet useable.
+
+## Structure
+
+Vendure is a headless framework, which means that it is just an API serving JSON via a GraphQL endpoint. The code for
+the server is located in the `server` directory.
+
+We will ship with an administration UI which is a stand-alone web application which can be used to perform tasks such
+as inventory, order and customer management. The code for this is located in the `admin-ui` directory.
+
+## Development
+
+### Server
+
+* `cd server && yarn`
+* `yarn start:dev`
+
+### Admin UI
+
+* `cd admin-ui && yarn`
+* `yarn start`
+
+## License
+
+MIT

+ 0 - 1
server/LICENSE.md

@@ -1 +0,0 @@
-(c) Copyright 2018 Michael Bromley, all rights reserved.

+ 1 - 1
server/package.json

@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "description": "A modern, headless ecommerce framework",
   "private": true,
-  "license": "SEE LICENSE IN LICENSE.md",
+  "license": "MIT",
   "scripts": {
     "format": "prettier --write \"modules/**/*.ts\"",
     "populate": "ts-node -r tsconfig-paths/register mock-data/populate.ts",