refactored readme stuff and added more contributing docs

.gitignore

@@ -1,6 +1,5 @@
 build/
 coverage/
 node_modules/
-typings/
 npm-debug.log
-config/parameters.json
+ormconfig.json

CHANGELOG.md

@@ -0,0 +1,12 @@
+# 0.0.2 (in development)
+
+* lot of API refactorings
+* complete support TypeScript 2
+* optimized schema creation 
+* command line tools
+* multiple drivers support
+* multiple bugfixes
+
+# 0.0.1
+
+* first stable version, works with TypeScript 1.x

CONTRIBUTING.md

@@ -0,0 +1,119 @@
+# Contributing to TypeORM
+
+We would love for you to contribute to TypeORM and help make it even better than it is today! 
+As a contributor, here are the guidelines we would like you to follow:
+
+ - [Question or Problem?](#question)
+ - [Issues and Bugs](#issue)
+ - [Feature Requests](#feature)
+ - [Submission Guidelines](#submit)
+
+## <a name="question"></a> Got a Question or Problem?
+
+There are several ways how you can ask your question:
+
+* You can create a question on [StackOverflow](stackoverflow.com/questions/tagged/typeorm) where the questions should be tagged with tag `typeorm`.
+* You can create issue on [github](https://github.com/typeorm/typeorm/issues)
+* You can write your questions in our [gitter channel](https://gitter.im/pleerock/typeorm)
+* If you have a Skype then try to find me there (`Umed Khudoiberdiev`)
+
+Prefered way if you create your question on StackOverflow, or create a github issue.
+
+## <a name="issue"></a> Found a Bug?
+
+If you find a bug in the source code, you can help us by [submitting an issue](#submit-issue) to our 
+[GitHub Repository](https://github.com/typeorm/typeorm). 
+Even better, you can [submit a Pull Request](#submit-pr) with a fix.
+
+## <a name="feature"></a> Missing a Feature?
+
+You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub
+Repository. If you would like to *implement* a new feature, please submit an issue with
+a proposal for your work first, to be sure that we can use it.
+Please consider what kind of change it is:
+
+* For a **Major Feature**, first open an issue and outline your proposal so that it can be
+discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
+and help you to craft the change so that it is successfully accepted into the project.
+* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
+
+## <a name="submit"></a> Submission Guidelines
+
+### <a name="submit-issue"></a> Submitting an Issue
+
+Before you submit an issue, please search the issue tracker, 
+maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
+
+We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it.
+ In order to reproduce bugs we ask you to provide a minimal code snippet that shows a reproduction of the problem. 
+
+You can file new issues by filling out our [new issue form](https://github.com/typeorm/typeorm/issues/new).
+
+### <a name="submit-pr"></a> Submitting a Pull Request (PR)
+Before you submit your Pull Request (PR) consider the following guidelines:
+
+* Search [GitHub](https://github.com/typeorm/typeorm/pulls) for an open or closed PR
+  that relates to your submission. You don't want to duplicate effort.
+* Make your changes in a new git branch:
+
+     ```shell
+     git checkout -b my-fix-branch master
+     ```
+
+* Create your patch, **including appropriate test cases**. Without tests your PR will not be accepted.
+* Follow our [Coding Rules](#rules).
+* Run the full TypeORM test suite, as described in the [developer documentation](DEVELOPER.md), and ensure that all tests pass.
+* Commit your changes using a descriptive commit message
+
+     ```shell
+     git commit -a
+     ```
+
+* Push your branch to GitHub:
+
+    ```shell
+    git push origin my-fix-branch
+    ```
+
+* In GitHub, send a pull request to `typeorm:master`.
+* If we suggest changes then:
+  * Make the required updates.
+  * Re-run the TypeORM test suites to ensure tests are still passing.
+  * Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
+
+    ```shell
+    git rebase master -i
+    git push -f
+    ```
+
+That's it! Thank you for your contribution!
+
+#### After your pull request is merged
+
+After your pull request is merged, you can safely delete your branch and pull the changes
+from the main (upstream) repository:
+
+* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
+
+    ```shell
+    git push origin --delete my-fix-branch
+    ```
+
+* Check out the master branch:
+
+    ```shell
+    git checkout master -f
+    ```
+
+* Delete the local branch:
+
+    ```shell
+    git branch -D my-fix-branch
+    ```
+
+* Update your master with the latest upstream version:
+
+    ```shell
+    git pull --ff upstream master
+    ```
+

DEVELOPER.md

@@ -0,0 +1,95 @@
+# Building and Testing TypeORM
+
+This document describes how to set up your development environment and run TypeORM test cases.
+
+* [Prerequisite Software](#prerequisite-software)
+* [Getting the Sources](#getting-the-sources)
+* [Installing NPM Modules](#installing-npm-modules)
+* [Building](#building)
+* [Running Tests Locally](#running-tests-locally)
+
+See the [contribution guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md)
+if you'd like to contribute to Angular.
+
+## Prerequisite Software
+
+Before you can build and test TypeORM, you must install and configure the
+following products on your development machine:
+
+* [Git](http://git-scm.com) and/or the **GitHub app** (for [Mac](http://mac.github.com) or
+  [Windows](http://windows.github.com)); [GitHub's Guide to Installing
+  Git](https://help.github.com/articles/set-up-git) is a good source of information.
+
+* [Node.js](http://nodejs.org), (better to install latest version) which is used to run a development web server,
+  run tests, and generate distributable files. 
+  Depending on your system, you can install Node either from source or as a pre-packaged bundle.
+* [Mysql](https://www.mysql.com/) is required to run tests on this platform
+* [MariaDB](https://mariadb.com/) is required to run tests on this platform
+* [Postgres](https://www.postgresql.org/) is required to run tests on this platform
+* [Oracle](https://www.oracle.com/database/index.html) is required to run tests on this platform
+* [Microsoft SQL Server](https://www.microsoft.com/en-us/cloud-platform/sql-server) is required to run tests on this platform
+
+## Getting the Sources
+
+Fork and clone the repository:
+
+1. Login to your GitHub account or create one by following the instructions given [here](https://github.com/signup/free).
+2. [Fork](http://help.github.com/forking) the [main TypeORM repository](https://github.com/typeorm/typeorm).
+3. Clone your fork of the TypeORM repository and define an `upstream` remote pointing back to
+   the TypeORM repository that you forked in the first place.
+
+```shell
+# Clone your GitHub repository:
+git clone git@github.com:<github username>/typeorm.git
+
+# Go to the TypeORM directory:
+cd typeorm
+
+# Add the main TyepORM repository as an upstream remote to your repository:
+git remote add upstream https://github.com/typeorm/typeorm.git
+```
+## Installing NPM Modules
+
+Install all TypeORM dependencies by running this command:
+
+```shell
+npm install
+```
+
+During installation you may have some probelems with some dependencies. 
+For example to proper install oracle driver you need to follow all instructions from
+ [node-oracle documentation](https://github.com/oracle/node-oracledb).
+
+Also install these packages globally:
+
+* `npm install -g gulp` (you might need to prefix this command with `sudo`)
+* `npm install -g typescript` (you might need to prefix this command with `sudo`)
+
+## Building
+
+To build a distribution package of TypeORM run:
+
+```shell
+gulp package
+```
+
+This command will generate you a distribution package in the `build/package` directory.
+You can link (or simply copy/paste) this directory into your project and test TypeORM there
+(but make sure to keep all node_modules required by TypeORM).
+
+## Running Tests Locally
+
+Setup your environment configuration by copying `ormconfig.json.dist` into `ormconfig.json` and 
+replacing parameters with your own.
+
+Then run tests:
+
+```shell
+gulp tests
+```
+
+You should execute test suites before submitting a PR to github.
+All the tests are executed on our Continuous Integration infrastructure and a PR could only be merged once the tests pass.
+
+
+

LICENCE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2015-2016 Yakdu. http://typeorm.github.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.