From 05d4d8ac414afdcacac7bf3319aba78ea67fbe94 Mon Sep 17 00:00:00 2001
From: ccoffrin <carleton@coffrin.com>
Date: Sun, 15 Jul 2018 12:23:19 -0600
Subject: [PATCH] updating readme and changelog

---
 CHANGELOG.md |  8 ++++++++
 README.md    | 28 +++++++++++++++++++++++-----
 REQUIRE      |  2 +-
 3 files changed, 32 insertions(+), 6 deletions(-)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 000000000..c5e7707c0
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,8 @@
+ThreePhasePowerModels.jl Change Log
+===================================
+
+### Staged
+- nothing
+
+### v0.1.0
+- Initial release
\ No newline at end of file
diff --git a/README.md b/README.md
index b64466abe..3b5ca167f 100644
--- a/README.md
+++ b/README.md
@@ -4,14 +4,32 @@ Dev:
 [![Build Status](https://travis-ci.org/lanl-ansi/ThreePhasePowerModels.jl.svg?branch=master)](https://travis-ci.org/lanl-ansi/ThreePhasePowerModels.jl)
 [![codecov](https://codecov.io/gh/lanl-ansi/ThreePhasePowerModels.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/lanl-ansi/ThreePhasePowerModels.jl)
 
-A Julia/JuMP Package for Three Phase Power Network Optimization
+ThreePhasePowerModels.jl is an extention package of PowerModels.jl for Steady-State Power Distribution Network Optimization.  It is designed to enable computational evaluation of emerging power network formulations and algorithms in a common platform.  The code is engineered to decouple problem specifications (e.g. Power Flow, Optimal Power Flow, ...) from the power network formulations (e.g. AC, linear-approximation, SOC-relaxation, ...).
+This enables the definition of a wide variety of power network formulations and their comparison on common problem specifications.
+
+**Core Problem Specifications**
+* Power Flow (pf)
+* Optimal Power Flow (opf)
+
+**Core Network Formulations**
+* AC (polar and rectangular coordinates)
+* SOC Relaxation (W-space)
+
+**Network Data Formats**
+* Matlab ".m" files
+* OpenDSS ".dss" files
 
 **Warning:** This package is under active development and may change drastically without warning.
 
-This package can be installed with the following command,
-```
-Pkg.clone("git@github.com:lanl-ansi/ThreePhasePowerModels.jl.git")
-```
+## Development
+
+Community-driven development and enhancement of ThreePhasePowerModels are welcome and encouraged. Please fork this repository and share your contributions to the master with pull requests.
+
+
+## Acknowledgments
+
+This code has been developed as part of the Advanced Network Science Initiative at Los Alamos National Laboratory.  The primary developers are David Fobes(@pseudocubic) and Carleton Coffrin(@ccoffrin) with support from the following contributors,
+- Frederik Geth (@frederikgeth) CSIRO, Distribution modeling advise
 
 ## License
 
diff --git a/REQUIRE b/REQUIRE
index dfc4e34a2..484605765 100644
--- a/REQUIRE
+++ b/REQUIRE
@@ -1,7 +1,7 @@
 julia 0.6
 
 JuMP 0.17 0.19-
-PowerModels 0.6 0.8-
+PowerModels 0.8 0.9-
 InfrastructureModels 0.0.4 0.2-
 Memento 0.8