From 0946172dc526f5ca512648af7d7444f9983158c1 Mon Sep 17 00:00:00 2001 From: Devon Carew <devoncarew@gmail.com> Date: Mon, 20 Oct 2014 09:14:14 -0700 Subject: [PATCH] some doc changes --- CHANGELOG.md | 3 ++- README.md | 51 +++++++++----------------------------------- lib/src/cli_app.dart | 2 ++ pubspec.yaml | 2 +- 4 files changed, 15 insertions(+), 43 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a42d0f3..9f49362 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,8 +4,9 @@ * Removed Web Starter Kit, waiting for at least WSK 0.6.0 * Renamed `helloworld` to `consoleapp` -* Adding default BSD license to projects * Added `polymer` template +* Added `shelfapp` template +* Added default BSD license to projects ## 0.0.5 diff --git a/README.md b/README.md index e766085..6795f71 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ Kit and Yeoman. * consoleapp - a minimal command-line script * package - a library for pub, complete with tests * polymer - a web app with Polymer.dart and paper (material design) elements +* shelfapp - a minimal web server using the shelf package * webapp - a minimal responsive web app, with Sass, routing, and more -* More to come! ## Installation @@ -32,29 +32,25 @@ Install: As an example, here is how you create a webapp with Stagehand: -With Dart 1.6: - - $> cd where_you_want_to_create_the_project_directory - $> pub global run stagehand -o _directory_name_ webapp - With Dart 1.7 or greater: $> cd where_you_want_to_create_the_project_directory $> stagehand -o _directory_name_ webapp -Here is how you list all of the project templates: - With Dart 1.6: - $> pub global run stagehand - + $> cd where_you_want_to_create_the_project_directory + $> pub global run stagehand -o _directory_name_ webapp + +Here is how you list all of the project templates: + With Dart 1.7 or greater: $> stagehand - -or - $> stagehand --help +With Dart 1.6: + + $> pub global run stagehand ## Goals @@ -64,34 +60,7 @@ or * Becomes the best way to create a new Dart project * Used by WebStorm, CDE, Sublime, and more * Distributed as a pub package - -## Non-goals - -* Fostering an entire ecosystem of generators -* This project is opinionated. It’s not a framework for generators. - -## Requirements - -* Open source, hosted on github -* Run the generators via `pub global run` - * or, via an API exposed by the package -* Single package -* Generators for: - * Dart + HTML app - * this is the most minimal option. for the developer that doesn’t want to - be confused by too much going on. - * Dart + Polymer app - * this is the most opinionated and complete option. for the developer that - says "I just want to paint by numbers" - * Dart + server-side - * Dart library (suitable to publish on pub.dartlang.org) -* Anonymous and opt-in usage analytics -* Creates - * the project directory itself - * all required directories - * pubspec.yaml file - * .gitignore file - * initial files like index.html +* Non-goal: fostering an entire ecosystem of generators. This project is opinionated. It’s not a framework for generators. ## Issues and bugs diff --git a/lib/src/cli_app.dart b/lib/src/cli_app.dart index aa37064..966e998 100644 --- a/lib/src/cli_app.dart +++ b/lib/src/cli_app.dart @@ -16,6 +16,8 @@ import 'package:stagehand/analytics/analytics_io.dart'; import 'package:stagehand/src/common.dart'; const String APP_NAME = 'stagehand'; + +// This version must be updated in tandem with the pubspec version. const String APP_VERSION = '0.0.5-dev'; // The Google Analytics tracking ID for stagehand. diff --git a/pubspec.yaml b/pubspec.yaml index 75bb35d..7af557a 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -3,7 +3,7 @@ # license that can be found in the LICENSE file. name: stagehand -# When changing this version, change the bin/stagehand.dart version as well. +# When changing this version, change the lib/src/cli_app.dart version as well. version: 0.0.5-dev description: > A scaffolding generator for your Dart projects. Stagehand helps you get set -- GitLab