doc changes

google · Dec 18, 2014 · 0709268 · 0709268
1 parent 818b3cc
commit 0709268
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 8 deletions.
diff --git a/.project b/.project
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <projectDescription>
-	<name>tuneup-dart</name>
+	<name>tuneup.dart</name>
 	<comment></comment>
 	<projects>
 	</projects>

diff --git a/AUTHORS b/AUTHORS
@@ -1,5 +1,5 @@
 # Below is a list of people and organizations that have contributed
-# to the Dart project. Names should be added to the list like so:
+# to the tuneup.dart project. Names should be added to the list like so:
 #
 #   Name/Organization <email address>
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/changelog.md b/changelog.md
@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1
+
+* Initial version, created by Stagehand
diff --git a/README.md → readme.md b/README.md → readme.md
@@ -4,12 +4,14 @@ A command-line tool to manipulate and inspect your Dart projects.
 
 [![Build Status](https://travis-ci.org/google/tuneup.dart.svg)](https://travis-ci.org/google/tuneup.dart)
 
-## Usage
+## Installing
 
 To install, run:
 
     pub global activate tuneup
 
+## Running
+
 Run `tuneup` (or `pub global run tuneup`) to see a list of available commands.
 
 - *init*: create a new project
@@ -18,6 +20,20 @@ Run `tuneup` (or `pub global run tuneup`) to see a list of available commands.
    errors
 - *clean*: clean the project (remove the build/ directory)
 
+Then run a tuneup command, like analyze:
+
+    pub global run tuneup analyze
+
+or,
+
+    tuneup analyze
+
+from the root of your project.
+
 ## Filing Issues
 
 Please file reports on the [GitHub Issue Tracker](https://github.com/google/tuneup.dart/issues)
+
+## Disclaimer
+
+This is not an official Google product.