about_yml 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a26a63746b2e58de3584dbee54db450d1b63528
-  data.tar.gz: 112da4095c5c05b95f3e962bcb161ce4463296c4
+  metadata.gz: 8f9b2e75f68ce3cc2997bc8a1f317a4c5b0f8c46
+  data.tar.gz: c7517db21a8cb58ed77ceac452701a078d5e3480
 SHA512:
-  metadata.gz: 77dd208381be15190a557d7ec3aa20e3c39462470f4d9af35418e73b0911aeb55d87858f8860233c6ecfc76b0f3026c17c7f737ec50a848bebefe0f95493fcd1
-  data.tar.gz: a3c75fc5809baa0c0df4e471f3a5140611fd4650ed869cb14a43bdc99ababf569edcc1511ae830a7791685bf9f10edbcd5bee4a7d0319c18165230562ca086a1
+  metadata.gz: c2352467181d29da1a49a2bbca122ce2776a1406191c625cb1a93573296993b28b32053c66468554911f5713a14770548d80c5f2db376cc686e6c1e6a7d82f4c
+  data.tar.gz: 2e9fe6e9d4c221567477dffc98994f22b5c1a5792e51429cf37c262bc539fa1684cc762d5128df15568ee7c855cbdfede4cf32956059282b24c2c467c33a90f3

data/README.md

@@ -22,6 +22,13 @@ web site, cultivation of `.about.yml` files will help make our activity more
 easily transparent to our teammates, and to anyone outside our team who wishes
 to discover what we're working on (and how we work).
 
+## Quick start
+
+Copy the [`template.yml`](./template.yml) file from this repository into the
+root directory of your project's repository as `.about.yml`. Then refer to the
+[cheat sheet](#cheat-sheet) for instructions regarding how to fill in the
+data.
+
 ## Installation
 
 Run `gem install about_yml` on the command line. You can also add `gem
@@ -117,7 +124,7 @@ script: bundle exec rake run_about_yml_check
 ```
 
 
-## `.about.yml` cheat sheet
+## <a name="cheat-sheet"></a>`.about.yml` cheat sheet
 The following attributes are currently stored in the `.about.yml` file and are used in one or more of the locations referenced above. Required attributes are marked with an asterisk, and field descriptions and examples follow each attribute. Take a look at [Every Kid in a Park](https://github.com/18F/ekip-api/blob/master/.about.yml) or [Open Opportunities](https://github.com/18F/openopps-platform/blob/dev/.about.yml) for living examples of `.about.yml` in action.
 
 
@@ -202,6 +209,13 @@ team:
   id: khandelwal
 ```
 
+`milestones` - What are the key milestones you've achieved recently?
+>
+```yml
+milestones:
+- "December 2015: Discovery completed"
+```
+
 `type` - What kind of content is contained in the project repository? *Accepted values: app, docs, policy*
 > 
 ```yml

data/lib/about_yml/schema.json

@@ -27,7 +27,7 @@
         },
         "stage": {
             "type": "string",
-            "description": "MWhat is your project's current status?",
+            "description": "What is your project's current status?",
             "enum": ["discovery", "alpha", "beta", "live"]
         },
         "testable": {

data/lib/about_yml/version.rb

@@ -1,5 +1,5 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 module AboutYml
-  VERSION = '0.0.9'
+  VERSION = '0.0.10'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: about_yml
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Mike Bland
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: ".about.yml project metadata schema and tools"