Update documentation and changelog

CHANGELOG.md

@@ -5,7 +5,10 @@ All notable changes to this project will be documented in this file.
 ## Release 0.1.0
 
 **Features**
+* Basic taskserver installation
+* Generate self-signed certificates
 
 **Bugfixes**
 
 **Known Issues**
+None, since it hasn't even been tested. ;)

README.md

@@ -1,16 +1,5 @@
-
 # taskd
 
-Welcome to your new module. A short overview of the generated parts can be found in the PDK documentation at https://puppet.com/pdk/latest/pdk_generating_modules.html .
-
-The README template below provides a starting point with details about what information to include in your README.
-
-
-
-
-
-
-
 #### Table of Contents
 
 1. [Description](#description)
@@ -25,38 +14,30 @@ The README template below provides a starting point with details about what info
 
 ## Description
 
-Start with a one- or two-sentence summary of what the module does and/or what problem it solves. This is your 30-second elevator pitch for your module. Consider including OS/Puppet version it works with.
+This module will install the [Taskwarrior](https://taskwarrior.org) "taskserver" (taskd).
 
-You can give more descriptive information in a second paragraph. This paragraph should answer the questions: "What does this module *do*?" and "Why would I use it?" If your module has a range of functionality (installation, configuration, management, etc.), this is the time to mention it.
+It will take of installing the software and generating self-signed server-client certificates.
 
 ## Setup
 
-### What taskd affects **OPTIONAL**
-
-If it's obvious what your module touches, you can skip this section. For example, folks can probably figure out that your mysql_instance module affects their MySQL instances.
-
-If there's more that they should know about, though, this is the place to mention:
-
-* Files, packages, services, or operations that the module will alter, impact, or execute.
-* Dependencies that your module automatically installs.
-* Warnings or other important notices.
-
-### Setup Requirements **OPTIONAL**
-
-If your module requires anything extra before setting up (pluginsync enabled, another module, etc.), mention it here.
+### Beginning with taskd
 
-If your most recent release breaks compatibility or requires particular steps for upgrading, you might want to include an additional "Upgrading" section here.
+Simply include the taskd class on whatever node you want it to be set up:
 
-### Beginning with taskd
+```
+include taskd
+```
 
-The very basic steps needed for a user to get the module up and running. This can include setup steps, if necessary, or it can be an example of the most basic use of the module.
+This will install taskd, make it listen on the default port (FIXME) on your node's FQDN, and generate the default self-signed certificates.
 
 ## Usage
 
+FIXME
 This section is where you describe how to customize, configure, and do the fancy stuff with your module here. It's especially helpful if you include usage examples and code samples for doing things with your module.
 
 ## Reference
 
+FIXME
 Users need a complete list of your module's classes, types, defined types providers, facts, and functions, along with the parameters for each. You can provide this list either via Puppet Strings code comments or as a complete list in the README Reference section.
 
 * If you are using Puppet Strings code comments, this Reference section should include Strings information so that your users know how to access your documentation.
@@ -70,12 +51,10 @@ Users need a complete list of your module's classes, types, defined types provid
 
 ## Limitations
 
+FIXME
 This is where you list OS compatibility, version compatibility, etc. If there are Known Issues, you might want to include them under their own heading here.
 
 ## Development
 
+FIXME
 Since your module is awesome, other users will want to play with it. Let them know what the ground rules for contributing are.
-
-## Release Notes/Contributors/Etc. **Optional**
-
-If you aren't using changelog, put your release notes here (though you should consider using changelog). You can also add any additional sections you feel are necessary or important to include here. Please use the `## ` header.

metadata.json

@@ -2,9 +2,9 @@
   "name": "towo-taskd",
   "version": "0.1.0",
   "author": "Tobias Wolter",
-  "summary": "",
+  "summary": "Installs and configures the taskwarrior taskd",
   "license": "Apache-2.0",
-  "source": "",
+  "source": "https://github.com/towo/puppet-taskd",
   "dependencies": [
 
   ],