Merge pull request #4 from tparnell8/readme

license and readme

LICENSE.txt

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+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.

Readme.md

@@ -0,0 +1,39 @@
+This is the code for [dotnetmashup.azurewebsites.net](dotnetmashup.azurewebsites.net) a mashup of news feeds for the `.net` community.
+
+
+## Why?
+
+Right now ASP.NET 5 has a multitude of news from tweets, blog posts, [announcements repo](https://github.com/aspnet/Announcements), and the community standup.
+
+This app is designed to try to aggregate them in one continuous scroll web page.
+
+
+
+## How do I add my blog?
+
+Add your blog information to src/DotNetMashup.Web/blogfeed.json submit a PR
+
+
+## Contributing
+
+Contributions are welcome, submit an issue with the feature you would like to add so we can discuss it ahead of time. To get the various feeds working you must add api keys to the `startup.cs` file.
+
+
+You will need twitter, and github keys (or you can turn off said feeds in RepositoryFactory.cs)
+
+You will need to do something like the following in `startup.cs` (please remember to not commit this). Usually these keys come from environment variables, you could also place them there, and not worry about altering `startup.cs`
+
+```csharp
+public Startup(IHostingEnvironment env, IApplicationEnvironment appEnv)
+       {
+           config = new ConfigurationBuilder()
+           .AddEnvironmentVariables()
+           .Build();
+           config["github"] = "githubkeyhere";
+           config["twitterkey"] = "Consumer Key";
+           config["twittersecret"] = "Consumer Secret ";
+           config["twittertokenKey"] = "Access Token";
+           config["twittertokenSecret"] = "Access Token Secret";
+       }
+
+```