Merge pull request #1 from watson-health-fhir-server/doc-fixes

Doc fixes

README.md

@@ -1,104 +1,34 @@
 ## IBM Watson Health FHIR Server
 
 ### Overview
-The Watson Health FHIR Server provides a modular implementation of version r4 of the [HL7 FHIR specification](https://www.hl7.org/fhir/r4/http.html) with a focus on performance and configurability.
+The Watson Health FHIR Server is a modular Java implementation of version 4 of the [HL7 FHIR specification](https://www.hl7.org/fhir/r4/http.html) with a focus on performance and configurability.
 
-CODE_REMOVED
+For a detailed description of FHIR conformance, please see https://github.com/ibm/fhir/blob/master/docs/Conformance.md.
 
-CODE_REMOVED
-
-CODE_REMOVED
-
-CODE_REMOVED
+The server is packaged as a set of jar files, a web application archive (war), an application installer, and a Docker image.
 
 ### Running the Watson Health FHIR Server
-CODE_REMOVED
-
-CODE_REMOVED
-
-Alternatively, we are now building an Ubuntu-based docker image of the Watson Health FHIR Server (along-side the installer).
-To pull the latest fhir-server image:
-1. `docker login wh-fhir-server-snapshots-docker-local.artifactory.swg-devops.com`
-2. `docker pull wh-fhir-server-snapshots-docker-local.artifactory.swg-devops.com/fhir-server`
-Release versions will be available from `wh-fhir-server-releases-docker-local.artifactory.swg-devops.com`.
-
-If you intend to use these artifacts in a service or solution, please enter a dependency in [ClearingHouse](https://clearinghousev2.raleigh.ibm.com/CHNewCHRDM/CCHMServlet#&nature=wlhNDE&deliverableId=857565F0B78F11E88857DCC2171712A1).
+For information on installing and running the Watson Health FHIR Server, please see the User Guide at https://github.com/ibm/fhir/blob/master/docs/FHIRServerUsersGuide.md.
 
 ### Building on top of the Watson Health FHIR Server
-Once you've been added to the `afaas-wh-fhir-server-read` BlueGroup controlling access to Artifactory, you can add dependencies to our jar files by adding our repositories to your maven config. One common pattern is to add the repositories to your parent pom and your Artifactory username/apikey to your personal setting (e.g. ~/.m2/settings.xml).
+Watson Health FHIR Server artifacts are available on JCenter and Maven Central with a group ID of `com.ibm.watson.health`.
 
-Sample snippet for pom.xml:
-```
-<repositories>
-    <repository>
-        <id>na-artifactory-3rdparty</id>
-CODE_REMOVED
-    </repository>
-    <repository>
-        <id>na-artifactory-snapshots</id>
-CODE_REMOVED
-    </repository>
-    <repository>
-        <id>na-artifactory-releases</id>
-CODE_REMOVED
-    </repository>
-</repositories>
-```
+For example, if you are using Maven and would like to use our object model (including our high-performance parser, generator, and validator), you could declare the dependency like this:
 
-Sample snippet for settings.xml:
-```
-<servers>
-    <server>
-      <username></username>
-      <password></password>
-      <id>na-artifactory-snapshots</id>
-    </server>
-    <server>
-      <username></username>
-      <password></password>
-      <id>na-artifactory-3rdparty</id>
-    </server>
-    <server>
-      <username></username>
-      <password></password>
-      <id>na-artifactory-releases</id>
-    </server>
-</servers>
-```
-
-Once configured, you can add dependencies on specific fhir-server artifacts like this:
 ```
+...
 <dependencies>
     <dependency>
-      <groupId>com.ibm.watsonhealth.fhir</groupId>
+      <groupId>com.ibm.watson.health</groupId>
       <artifactId>fhir-model</artifactId>
       <version>${fhir.version}</version>
     </dependency>
     ...
 ```
 
-If you intend to use these artifacts in a service or solution, please enter a dependency in [ClearingHouse](https://clearinghousev2.raleigh.ibm.com/CHNewCHRDM/CCHMServlet#&nature=wlhNDE&deliverableId=857565F0B78F11E88857DCC2171712A1).
-
 ### Contributing to the Watson Health FHIR Server
-CODE_REMOVED
-
-CODE_REMOVED
-
-Pull requests are open.
-
-**Note to developers:**  
-To associate a commit with a github issue, add "issue #nnn -" on the front of your commit message, like this:  
-
-        git commit -m "issue #123 - Finished the FHIR Server code"  
-
-If you forget to include your work item number in your commit message, you can always "amend" the commit message
-by running this command prior to pushing your changes to the server:  
-
-        git commit --amend  
-        (this will open up your editor and allow you to change the commit message)
+See [CONTRIBUTING.md](CONTRIBUTING.md).
 
-#### 
-Jenkins jobs are located at: 
-- [Pre-Integration](https://wh-fhir-server-jenkins.swg-devops.com/job/fhir-server-r4/job/development/job/r4-pre-integration/)
-- [Integration](https://wh-fhir-server-jenkins.swg-devops.com/job/fhir-server-r4/job/release-4.0.0/)
-- [Release-Candidate](https://wh-fhir-server-jenkins.swg-devops.com/job/fhir-server-r4/job/release-4.0.0/)
+### License
+The Watson Health FHIR Server is licensed under the Apache 2.0 license. Full license text is
+available at [LICENSE](LICENSE).