Merge pull request #6 from fortizpenaloza/master

Migration from Smalltalkhub

.project

@@ -0,0 +1,3 @@
+{
+	'srcDirectory' : 'source'
+}

.smalltalk.ston

@@ -0,0 +1,15 @@
+SmalltalkCISpec {
+  #loading : [
+    SCIMetacelloLoadSpec {
+      #baseline : 'Teapot',
+      #directory : 'source',
+      #load : [ 'Tests' ],
+      #platforms : [ #pharo ]
+    } 
+  ], 
+  #testing : {
+    #coverage : {
+      #packages : [ 'Teapot-Core' ]
+    }
+  }
+}

.travis.yml

@@ -0,0 +1,13 @@
+language: smalltalk
+sudo: false
+
+os:
+  - linux
+
+smalltalk:
+  - Pharo-6.1
+  - Pharo-7.0
+  - Pharo64-7.0
+
+matrix:
+  fash_finish: true

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+Contributing
+============
+
+There's several ways to contribute to the project: reporting bugs, sending feedback, proposing ideas for new features, fixing or adding documentation, promoting the project, or even contributing code.
+
+## Reporting issues
+
+You can report issues [here](https://github.com/zeroflag/Teapot/issues/new)
+
+## Contributing Code
+- This project is MIT licensed, so any code contribution MUST be under the same license.
+- This project uses [Semantic Versioning](http://semver.org/), so keep it in mind when you make backwards-incompatible changes. If some backwards incompatible change is made the major version MUST be increased.
+- The source code is hosted in this repository using the Tonel format in the `source` folder.
+- The master branch contains the latest changes and should always be in a releasable state.
+- Feel free to send pull requests or fork the project.
+- Code contributions without test cases have a lower probability of being merged into the main branch.
+
+### Using Iceberg
+1. Download a [Pharo Image and VM](https://get.pharo.org/64)
+2. Clone the project or your fork using Iceberg
+3. Open the Working Copy and using the contextual menu select `Metacello -> Install baseline...`
+4. Input `Development`
+5. This will load the base code and the test cases
+6. Create a new branch to host your code changes
+7. Do the changes
+8. Run the test cases
+9. Commit and push your changes to the branch using the Iceberg UI
+10. Create a Pull Request against the master branch
+
+## Contributing documentation
+
+The project documentation is maintained in this repository in the `docs` folder and licensed under CC BY-SA 4.0. To contribute some documentation or improve the existing, feel free to create a branch or fork this repository, make your changes and send a pull request.
+

README.md

@@ -1,7 +1,30 @@
-# Teapot
-Teapot micro web framework for Pharo Smalltalk
+# Teapot  
 
-![alt tag](http://jshot.info/teapot/tea_small.png)
+Teapot is micro web framework for [Pharo Smalltalk](https://pharo.org) on top of the [Zinc HTTP components](https://github.com/svenvc/zinc), that focuses on simplicity and ease of use. It's around 600 lines of code, not counting the tests.
 
+**[Explore the docs](/docs)**
 
-Wiki, Code: <a href="http://smalltalkhub.com/#!/~zeroflag/Teapot">smalltalkhub</a>
+[![Build Status](https://travis-ci.com/fortizpenaloza/Teapot.svg?branch=master)](https://travis-ci.com/fortizpenaloza/Teapot)
+[![Coverage Status](https://coveralls.io/repos/github/fortizpenaloza/Teapot/badge.svg?branch=master)](https://coveralls.io/github/fortizpenaloza/Teapot?branch=master)
+
+> *Name origin*: [418 I'm a teapot](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) (RFC 2324) is an HTTP status code.
+
+This code was defined in 1998 as one of the traditional IETF April Fools' jokes, in RFC 2324, Hyper Text Coffee Pot Control Protocol. The RFC specifies this code should be returned by tea pots requested to brew coffee.
+
+## License
+- The code is licensed under [MIT](LICENSE).
+- The documentation is licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/).
+
+## Quick Start
+
+- Download the latest [Pharo 32](https://get.pharo.org/) or [64 bits VM](https://get.pharo.org/64/).
+- Download a ready to use image from the [release page](http://github.com/zeroflag/Teapot/releases/latest)
+- Explore the [documentation](docs/).
+
+## Installation
+
+To load the project in a Pharo image, or declare it as a dependency of your own project follow this [instructions](docs/Installation.md)
+
+## Contributing
+
+Check the [Contribution Guidelines](CONTRIBUTING.md)

docs/Installation.md

@@ -0,0 +1,42 @@
+# Installation
+
+## Basic Installation
+
+You can load **Teapot** evaluating:
+```smalltalk
+Metacello new
+	baseline: 'Teapot';
+	repository: 'github://zeroflag/teapot:master/source';
+	load.
+```
+>  Change `master` to some released version if you want a pinned version
+
+## Using as dependency
+
+In order to include **Teapot** as part of your project, you should reference the package in your product baseline:
+
+```smalltalk
+setUpDependencies: spec
+
+	spec
+		baseline: 'Teapot'
+			with: [ spec
+				repository: 'github://zeroflag/Teapot:v{XX}/source';
+				loads: #('Deployment') ];
+		import: 'Teapot'.
+```
+> Replace `{XX}` with the version you want to depend on
+
+```smalltalk
+baseline: spec
+
+	<baseline>
+	spec
+		for: #common
+		do: [ self setUpDependencies: spec.
+			spec package: 'My-Package' with: [ spec requires: #('Teapot') ] ]
+```
+
+## For Pharo 5 and previous
+
+If you are using a Pharo older version see [Smalltalkhub](http://smalltalkhub.com/#!/~zeroflag/Teapot)