Browse Source

docs: Update readme with note on alpha release

Michael Bromley 7 years ago
parent
commit
351d8a9b25
1 changed files with 6 additions and 10 deletions
  1. 6 10
      README.md

+ 6 - 10
README.md

@@ -4,9 +4,10 @@
 
 
 A headless [GraphQL](https://graphql.org/) ecommerce framework built on [NestJS](https://nestjs.com/) with [TypeScript](http://www.typescriptlang.org/).
 A headless [GraphQL](https://graphql.org/) ecommerce framework built on [NestJS](https://nestjs.com/) with [TypeScript](http://www.typescriptlang.org/).
 
 
-### Status
+### Status & note on docs
 
 
-Currently in pre-alpha, i.e. it is not yet useable.
+Currently in pre-alpha. **Alpha release coming in Q1 2019**, at which point there will be some proper documentation. This readme is currently
+a somewhat unstructured collection of development-related notes. For updates follow [twitter.com/vendure_io](https://twitter.com/vendure_io).
 
 
 ## Structure
 ## Structure
 
 
@@ -128,13 +129,7 @@ Custom fields are configured by means of a `customFields` property in the Vendur
 
 
 ```TypeScript
 ```TypeScript
 bootstrap({
 bootstrap({
-    port: API_PORT,
-    apiPath: API_PATH,
-    cors: true,
-    jwtSecret: 'some-secret',
-    dbConnectionOptions: {
-        // ...
-    },
+    // ...
     customFields: {
     customFields: {
         Product: [
         Product: [
             { name: 'infoUrl', type: 'string' },
             { name: 'infoUrl', type: 'string' },
@@ -198,8 +193,9 @@ to another, as defined by the [OrderState definitions](server/src/service/helper
 ```TypeScript
 ```TypeScript
 export type OrderState =
 export type OrderState =
     | 'AddingItems'
     | 'AddingItems'
-    | 'ArrangingShipping'
     | 'ArrangingPayment'
     | 'ArrangingPayment'
+    | 'PaymentAuthorized'
+    | 'PaymentSettled'
     | 'OrderComplete'
     | 'OrderComplete'
     | 'Cancelled';
     | 'Cancelled';
 ```
 ```