feature/netcore (WIP)

CONTRIBUTING.md

@@ -0,0 +1,167 @@
+# Contributing to Appy.GitDb
+
+We'd love for you to contribute to our source code and to make RxGen even better than it is
+today! Here are the guidelines we'd like you to follow:
+
+ - [Code of Conduct](#coc)
+ - [Question or Problem?](#question)
+ - [Issues and Bugs](#issue)
+ - [Feature Requests](#feature)
+ - [Submission Guidelines](#submit)
+ - [Coding Rules](#rules)
+ - [Commit Message Guidelines](#commit)
+
+## <a name="coc"></a> Code of Conduct
+
+Help us keep the project open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## <a name="question"></a> Got a Question or Problem?
+
+
+## <a name="issue"></a> Found an Issue?
+
+If you find a bug in the source code or a mistake in the documentation, you can help us by
+submitting an issue to our [GitHub Repository](https://github.com/YellowLineParking/Appy.GitDb). Even better you can submit a Pull Request
+with a fix.
+
+**Please see the [Submission Guidelines](#submit) below.**
+
+## <a name="feature"></a> Want a Feature?
+
+You can request a new feature by submitting an issue to our [GitHub Repository](https://github.com/YellowLineParking/Appy.GitDb).  If you
+would like to implement a new feature then consider what kind of change it is:
+
+  prevent duplication of work, and help you to craft the change so that it is successfully accepted
+  into the project.
+* **Small Changes** can be crafted and submitted to the [GitHub Repository](https://github.com/YellowLineParking/Appy.GitDb) as a Pull
+  Request.
+
+## <a name="submit"></a> Submission Guidelines
+
+### Submitting an Issue
+
+If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize
+the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
+
+Providing the following information will increase the chances of your issue being dealt with
+quickly:
+
+* **Overview of the Issue** - if an error is being thrown a stack trace helps
+* **Motivation for or Use Case** - explain why this is a bug for you
+* **Appy.GitDb Version(s)** - is it a regression?
+* **Operating System** - is this a problem with all browsers or only specific ones?
+* **Reproduce the Error** - provide a example or an unambiguous set of steps.
+* **Related Issues** - has a similar issue been reported before?
+* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
+  causing the problem (line of code or commit)
+
+**If you get help, help others. Good karma rulez!**
+
+### Submitting a Pull Request
+Before you submit your pull request consider the following guidelines:
+
+* Search [GitHub](https://github.com/YellowLineParking/Appy.GitDb/pulls) for an open or closed Pull Request
+  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**.
+* Follow our [Coding Rules](#rules).
+* Run the test suite, as described below.
+* Commit your changes using a descriptive commit message that follows our
+  [commit message conventions](#commit).
+
+    ```shell
+    git commit -a
+    ```
+  Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
+
+* Build your changes locally to ensure all the tests pass:
+
+    ```shell
+    npm test
+    npm run build    
+    ```
+
+* Push your branch to GitHub:
+
+    ```shell
+    git push origin my-fix-branch
+    ```
+
+In GitHub, send a pull request to `Appy.GitDb:master`.
+
+If we suggest changes, then:
+
+* Make the required updates.
+* Re-run the test suite to ensure tests are still passing.
+* Commit your changes to your branch (e.g. `my-fix-branch`).
+* Push the changes to your GitHub repository (this will update your Pull Request).
+
+If the PR gets too outdated we may ask you to rebase and force push to update the PR:
+
+```shell
+git rebase master -i
+git push origin my-fix-branch -f
+```
+
+_WARNING: Squashing or reverting commits and force-pushing thereafter may remove GitHub comments
+on code that were previously made by you or others in your commits. Avoid any form of rebasing
+unless necessary._
+
+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
+    ```
+
+## <a name="rules"></a> Coding Rules
+
+To ensure consistency throughout the source code, keep these rules in mind as you are working:
+
+* All features or bug fixes **must be tested** by one or more unit tests.
+* All public API methods **must be documented** with XML documentation.
+
+### Subject
+The subject contains succinct description of the change:
+
+* use the imperative, present tense: "change" not "changed" nor "changes"
+* no dot (.) at the end
+
+### Body
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

README.md

@@ -28,7 +28,7 @@ or
 
 - .NET CLI Console
 ```
-dotnet add package CsvHelper
+dotnet add package Appy.GitDb.Local
 ```
 
 
@@ -51,8 +51,7 @@ var theObject = await db.Get<SomeClass>("master", "key")
 ```
 
 ### Remote mode
-
-In order to use Git as a remote database, you need to install the `Appy.GitDb.Server` project on a server.
+In order to use Git as a remote database, you can use one of the servers projects `Appy.GitDb.Server` (MVC5) or `Appy.GitDb.NetCore.Server` (NETCore) as base or just the remote package on your own code.
 
 Once the server is installed, you can use the `Appy.GitDb.Remote` package to talk to the server:
 
@@ -263,3 +262,7 @@ build.bat dev
 This will execute the tasks `clean`, `compile`, `test`, `pack`
 You can execute any of these tasks separately by running `build <task>`
 
+## Contribute
+It would be awesome if you would like to contribute code or help with bugs. Just follow the guidelines [CONTRIBUTING](https://github.com/YellowLineParking/Appy.GitDb/blob/master/CONTRIBUTING.md).
+
+