From 2d1e1b6f0a9e5072def27c50b0961600c1b30966 Mon Sep 17 00:00:00 2001 From: Radu Gidei Date: Wed, 30 Aug 2017 22:36:43 +0100 Subject: [PATCH] readme update for 1.0 release --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 41a8eb4..b2e74ba 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,14 @@ It's meant to provide building blocks so you can build Dynamo integrations with ![DynaWeb package screenshot](https://raw.githubusercontent.com/radumg/DynaWeb/master/samples/DynaWeb.png) -# Status : Alpha -The package is in active development and currently undergoing a (semi-private) alpha testing period. +# Status : Beta +The package is in active development and is currently available as an open beta. This stage is for intense feedback from you, testing it, so I would really like to know what cloud/web platforms you'd like to use Dynamo with and how. Please see and add your comments to this [first issue](https://github.com/radumg/DynaWeb/issues/1) and feel free to [open more issues](https://github.com/radumg/DynaWeb/issues/new) with any ideas you might have. ## Repository notes -This public repository is only hosting the issues and alpha builds of the package, accessible on the [releases page](https://github.com/radumg/DynaWeb/releases). +This public repository is only hosting the issues and in-progress builds of the package, accessible on the [releases page](https://github.com/radumg/DynaWeb/releases). The repository is only private in the sense that source code is not made available and contributions are by invite-only. If you would like to contribute and help develop it, please open an issue requesting access to the `development repo` instead. *Note : I have every intention to open-source this eventually but would like to focus on testing and validating some of the underlying assumptions before making it available to the general audience. The ultimate goal is to see this merged back into the Dynamo Core library, to enable as many people to start interacting with the web more.* @@ -24,6 +24,12 @@ The repository is only private in the sense that source code is not made availab # Getting Started +## Package manager +`DynaWeb` is now available on the Dynamo package manager, search for `DynaWeb` and install it. + +## Manual install +If you prefer to install one of the more experimental/work-in-progress builds, you can still follow the instructions below. + - Download the latest release from the [Releases page](https://github.com/radumg/DynaWeb/releases) - unzip the downloaded file - once unzipped, copy the `DynaWeb` folder to the location of your Dynamo packages : @@ -33,6 +39,8 @@ The repository is only private in the sense that source code is not made availab ## Still can't see the package in Dynamo ? +This issue should be fixed now the package is distributed through the package manager, I definitely recommending getting it that way. However, in case you still have issues, see instructions below : + As [reported](https://github.com/radumg/DynaWeb/issues/10) by users, Windows sometimes blocks `.dll` files for security reasons. To resolve this, you'll have to go through the steps below for each assembly (`.dll` file) in the package : 1. Right-click on `.dll` file and select properties 2. Tick the `Unblock` checkbox at the bottom, in the Security section. @@ -41,12 +49,12 @@ As [reported](https://github.com/radumg/DynaWeb/issues/10) by users, Windows som ![image](https://user-images.githubusercontent.com/15014799/29770289-3c13172a-8be6-11e7-983e-6fb3c71ad136.png) # Using DynaWeb -Please consult the sample files provided in this repository - they contain notes and instructions on how to use the nodes. I'm not providing extensive documentation on this page on purpose - to see how intuitive the design of the package & nodes is to first-time users. +Please consult the sample files provided in this repository and in the package's `extra` folder - they contain notes and instructions on how to use the nodes. I'm not providing extensive documentation on this page on purpose - to see how intuitive the design of the package & nodes is to first-time users. Feel free to submit PR if you want to add some documentation in the meantime. ## Samples -There are 6 sample Dynamo graphs included with the package, check out the `extra` folder in the downloaded package or the [samples folder](https://github.com/radumg/DynaWeb/tree/master/samples) of this repository. Also note the DYN samples are offered in both Dynamo 1.3 file format and Dynamo 2.0 new format. +There are 7 sample Dynamo graphs included with the package, check out the `extra` folder in the downloaded package or the [samples folder](https://github.com/radumg/DynaWeb/tree/master/samples) of this repository. Also note the DYN samples are offered in both Dynamo 1.3 file format and Dynamo 2.0 new format. The samples start from super-simple and increase in complexity : @@ -68,12 +76,16 @@ Introduces POST-ing to a REST API service and handling JSON payloads. Once the r __Sample 6 - Comples POST request__ further expands on the above example, building a complex `WebRequest` with 6 steps before its execution. +__Sample 7 - Upload file to Autodesk Forge__ +this example builds a `WebRequest` and attaches a file to it, to upload directly to the `Autodesk Forge` service. See the issue that sparked this sample [here](https://github.com/radumg/DynaWeb/issues/11). + ## Class structure -There's 4 main namespaces you'll find in DynaWeb : +There's 5 main namespaces you'll find in DynaWeb : - `WebRequest` : the web request that gets executed - `WebClient` : the context in which a request is executed - `WebResponse` : this contains the response from the server, as well as additional metadata about the response & server itself +- `Execution` : this provides nodes that simply execute requests, making it easier & clearer to use standard http verbs such as GET, POST, etc. - `Helpers` : a few helper nodes, with a particular focus on `Deserialisation.` Simply put, use `WebRequest` nodes for one-off requests and start using a `WebClient` when you are interacting with REST APIs and/or have multiple request to similar endpoints/URLs.