Added pdf and html docs

Author: atkawa7

README.md

@@ -11,7 +11,7 @@
 ***The motivation behind porting this is using it for generating snippets in swagger and redocs.
 The project is still in development phase***. 
 
-- [ ] Documentation
+- [x] Documentation
 - [x] Tests
 - [ ] Releasing to maven
 

docs/generator.png renamed to docs/images/generators.png

@@ -3,6 +3,92 @@
 
 An HTTP Request snippet generator for many languages & tools. It can generate code for over twelve different languages and currently supports cURL, Javascript, Node, C, Java, Objective-C, Swift, Python, Ruby, C#, Go, OCaml and more!.
 
+==== Usage
+Enable maven snapshots in `~/.m2/settings.xml`
+```xml
+<profiles>
+  <profile>
+     <id>allow-snapshots</id>
+     <activation><activeByDefault>true</activeByDefault></activation>
+     <repositories>
+       <repository>
+         <id>snapshots-repo</id>
+         <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+         <releases><enabled>false</enabled></releases>
+         <snapshots><enabled>true</enabled></snapshots>
+       </repository>
+     </repositories>
+   </profile>
+</profiles>
+```
+
+Then add this ```dependency``` to  ```pom.xml```
+
+```xml
+<dependency>
+     <groupId>io.github.atkawa7</groupId>
+     <artifactId>httpsnippet</artifactId>
+     <version>0.0.1-SNAPSHOT</version>
+</dependency>
+```
+
+Once you have added this as a dependency then you are ready to generate code snippets.
+
+
+```java
+public class Main {
+     public static void main(String[] args) throws Exception {
+         List<HarHeader> headers = new ArrayList<>();
+         List<HarQueryString> queryStrings = new ArrayList<>();
+
+         User user = new User();
+         Faker faker = new Faker();
+         user.setFirstName(faker.name().firstName());
+         user.setLastName(faker.name().lastName());
+
+
+         HarPostData harPostData =
+                 new HarPostDataBuilder()
+                         .withMimeType(MediaType.APPLICATION_JSON)
+                         .withText(ObjectUtils.writeValueAsString(user)).build();
+
+         HarRequest harRequest =
+                 new HarRequestBuilder()
+                         .withMethod(HttpMethod.GET.toString())
+                         .withUrl("http://localhost:5000/users")
+                         .withHeaders(headers)
+                         .withQueryString(queryStrings)
+                         .withHttpVersion(HttpVersion.HTTP_1_1.toString())
+                         .withPostData(harPostData)
+                         .build();
+
+         //Using default generator for the language
+         HttpSnippet httpSnippet = new HttpSnippetCodeGenerator().snippet(harRequest, Language.JAVA);
+         System.out.println(httpSnippet.getCode());
+
+         //Or directly using the generator
+         String code   = new OkHttp().code(harRequest);
+         System.out.println(code);
+
+     }
+
+     @Data
+     static class User {
+         private String firstName;
+         private String lastName;
+     }
+ }
+```
+
+
+For integrating with other third party i.e ```spring```, ```redoc```, ```swagger``` such as checkout the demo.
+
+```bash
+https://github.com/atkawa7/httpsnippet
+cd httpsnippet
+mvn clean install
+java -jar httpsnippet-demo/target/httpsnippet-demo-0.0.1-SNAPSHOT.jar
+```
 
 ==== Har Request
 
@@ -109,7 +195,7 @@ then it will be merged into a new list and the resulting url in code snippets wi
 
 ==== Generators
 
-Please start by browsing for available generators  and inspect each implementation. A generator is a simple module with a constructor that accepts two parameters: language and client where language is the target language i.e ```JAVA```, ```PYTHON```  and client is the target client that supports the language ```OKHTTP``` for ```JAVA```. The generator has ```generateCode``` function which converts ```HarRequest``` to ```HttpSnippet```.
+Please start by browsing for available generators  and inspect each implementation. A generator is a simple class with a constructor that accepts two parameters: language and client where language is the target language i.e ```JAVA```, ```PYTHON```  and client is the target client that supports the language ```OKHTTP``` for ```JAVA```. The generator has ```generateCode``` function which converts ```HarRequest``` to ```HttpSnippet```.
 
 [plantuml, generators]
 ....