From b77d614a6b22c40a89d3f936bf6cdc8bc93064e0 Mon Sep 17 00:00:00 2001
From: s0lray <s0lray@users.noreply.github.com>
Date: Fri, 19 Jan 2018 22:08:08 -0500
Subject: [PATCH] Updates to the readme

Updates to the readme
---
 README.md | 59 +++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 40 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index f32fef9..b68dfd8 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,52 @@
 http://osintframework.com
 
 ## Notes
-OSINT framework focused on gathering information from free tools or resources.  The intention is to help people find OSINT resources that return free information.  Some of the sites included may require registration or offer more data for $$$, but you should be able to get at least a portion of the available information for no cost.
+OSINT framework focused on gathering information from free tools or resources. The intention is to help people find free OSINT resources. Some of the sites included might require registration or offer more data for $$$, but you should be able to get at least a portion of the available information for no cost.
 
-I originally created this framework with an information security point of view.  Since then, the response from other fields and disciplines has been incredible.  I would love to be able to include any other OSINT resources, especially from fields outside of infosec.  Please let me know about anything that might be missing!
+I originally created this framework with an information security point of view. Since then, the response from other fields and disciplines has been incredible. I would love to be able to include any other OSINT resources, especially from fields outside of infosec. Please let me know about anything that might be missing!
 
+Please visit the framework at the link below and good hunting!
+http://osintframework.com
+
+### Legend
 (T) - Indicates a link to a tool that must be installed and run locally  
 (D) - Google Dork, for more information: <a href="https://en.wikipedia.org/wiki/Google_hacking">Google Hacking</a>  
 (R) - Requires registration  
 (M) - Indicates a URL that contains the search term and the URL itself must be edited manually  
 
-### Instructions for installing/running locally
+### For Update Notifications
+Follow me on Twitter: @jnordine - https://twitter.com/jnordine  
+Watch or star the project on Github: https://github.com/lockfale/osint-framework
+
+### Suggestions, Comments, Feedback
+Feedback or new tool suggestions are extremely welcome!  Please feel free to submit a pull request or open an issue on github or reach out on Twitter.
+
+### Contribute with a GitHub Pull Request
+For new resources, please ensure that the site is available for public and free use.
+<ol start="1">
+  <li>Note the next available ID listed in the description field on the OSINT Framework folder. This can be found at the bottom of arf.json</li>
+  <li>Update the arf.json file with the following format.</li>
+</ol>
+
+```
+{
+  "id": "1095",
+  "name": "Plessas",
+  "type": "url",
+  "url": "http://www.plessas.net/site/"
+}
+```
+
+<ol start="3">
+  <li>Update the next available ID in the OSINT Framework description field.</li>
+  <li>Submit pull request!</li>
+</ol>
+
+Thank you!
+
+
+
+## Instructions for installing/running locally
 
 <ol start="1">
   <li>Clone this repo</li>
@@ -33,19 +69,4 @@ _and then..._
   <li>Run `bower install`</li>
   <li>Run `cd ./public; python -m SimpleHTTPServer 8000` (you'll need python installed for this, of course)</li>
   <li>Open your browser to http://localhost:8000</li>
-</ol>
-
-### For Update Notifications
-Follow me on Twitter: @jnordine - https://twitter.com/jnordine  
-Watch or star the project on Github: https://github.com/lockfale/osint-framework
-
-### Suggestions, Comments, Feedback
-Feedback or new tool suggestions are extremely welcome!  Please feel free to submit a pull request or open an issue on github or reach out on Twitter.
-
-## To Do
-- [ ] Expand / Collapse all buttons
-- [ ] Single category expansion
-- [ ] Fix "the boldening"
-- [ ] Look into best way to display extra information for each site/tool
-- [ ] Find a good way to crowdsource rating information
-- [ ] Update d3js
+</ol>
\ No newline at end of file