Merge pull request #13 from ostranme/develop

Merge develop (2.0.0)
ostranme · Dec 4, 2015 · d1b09a6 · d1b09a6
2 parents 482d48d + c855736
commit d1b09a6
Show file tree

Hide file tree

Showing 18 changed files with 1,367 additions and 79 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,4 @@
-.DS_Store
+**/.DS_Store
+**/tmp
+**/.sass-cache
+**/node_modules
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -1,34 +1,62 @@
-#Swagger UI Themes:
+## Swagger UI Themes
+
+*Version 2.0.0*
 
 Swagger Docs are awesome. Why not make them look better! Below is a collection of themes for [Swagger UI](http://swagger.io/swagger-ui/).
+
+![](https://media2.giphy.com/media/62PP2yEIAZF6g/200.gif)
+
 You can find the Swagger UI project on GitHub [here](https://github.com/swagger-api/swagger-ui).
 
-### Flattop
+Get started at [http://meostrander.com/swagger-ui-themes/](http://meostrander.com/swagger-ui-themes/)
+
+## Getting started
+
+Download the swagger-ui-themes project and place the desired stylesheet into the source of your swagger-ui html.
+
+In the `<head>` of your html, reference the location to your [theme].css
+
+Make sure to either remove/comment out the link to `screen.css` or load the desired theme after to override the default Swagger UI styles.
+
+```html
+<link rel="stylesheet" href="path/to/swagger-ui-themes/css/theme-flattop.css">
+```
+#### Install with Bower
+
+```shell
+$ bower install swagger-ui-themes
+```
+
+
+## Themes
+
+#### Flattop
 ![Flattop Screenshot](https://github.com/ostranme/swagger-ui-themes/blob/master/screenshots/flattop.png)
 
-### Muted
+#### Muted
 ![Muted Screenshot](https://github.com/ostranme/swagger-ui-themes/blob/master/screenshots/muted.png)
 
-### Newspaper
+#### Newspaper
 ![Newspaper Screenshot](https://github.com/ostranme/swagger-ui-themes/blob/master/screenshots/newspaper.png)
 
-### Outline
+#### Outline
 ![Outline Screenshot](https://github.com/ostranme/swagger-ui-themes/blob/master/screenshots/outline.png)
 
-### Monokai
+#### Monokai
 ![Monokai Screenshot](https://github.com/ostranme/swagger-ui-themes/blob/master/screenshots/monokai.png)
 
-###Installation
----
-Simply just add one of the above stylesheets in the `themes` folder to the source of swagger-ui theme html page. Make sure to either remove/comment out the link to `screen.css` or load the desired theme after it to override the Swagger UI styles.
+#### Feeling Blue
+![Feeling Blue Screenshot](https://github.com/ostranme/swagger-ui-themes/blob/master/screenshots/feeling-blue.png)
+
+## Contributing
+
+If you want to add theme ideas or other fixes/changes to how the package works, feel free to submit an issue.
 
-###Demo
----
-The [Swagger Petstore](http://petstore.swagger.io/#/) was used as the example to showcase different themes. In the demo folder, open the index.html file and add a link to the desired theme you want by adding `<link href='PATH TO THEME' media='screen' rel='stylesheet' type='text/css'/>`. Next, either remove or comment out the `<link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/>` in the `<head>` tags. Serve up the index.html locally to view theme.
+#### Requesting new theme
 
-Feel free to open an issue or suggest more themes!
+- Title your new issue Theme request: theme-name (e.g., Theme request: theme-solarized).
+- Include a few use cases for your requested theme. How do you plan on using it?
 
-###License
----
+## License
 
-The MIT License. Read [LICENSE](LICENSE) for further information.
+- Code licensed under [MIT License](http://opensource.org/licenses/mit-license.html)
diff --git a/bower.json b/bower.json
@@ -1,20 +1,17 @@
 {
  "name": "swagger-ui-themes",
- "version": "1.0.6",
+ "version": "2.0.0",
  "homepage": "https://github.com/ostranme/swagger-ui-themes",
- "author": "ostranme",
- "description": "CSS themes for Swagger UI",
+ "author":
+ "Mark Ostrander <[email protected]>",
+ "description": "A collection of CSS themes for Swagger UI",
  "main": [
- "themes/theme-flattop.css",
- "themes/theme-monokai.css",
- "themes/theme-muted.css",
- "themes/theme-newspaper.css",
- "themes/theme-outline.css"
+ "themes/*.css"
  ],
  "keywords": [
  "theme",
  "swagger",
- "swagger",
+ "swagger UI",
  "ui",
  "flat"
  ],

diff --git a/screenshots/backup/flat-post.png b/screenshots/backup/flat-post.png
diff --git a/screenshots/backup/flat.png b/screenshots/backup/flat.png
diff --git a/screenshots/backup/monokai-post.png b/screenshots/backup/monokai-post.png
diff --git a/screenshots/backup/monokai.png b/screenshots/backup/monokai.png
diff --git a/screenshots/backup/mute-post.png b/screenshots/backup/mute-post.png
diff --git a/screenshots/backup/mute.png b/screenshots/backup/mute.png
diff --git a/screenshots/backup/newspaper-post.png b/screenshots/backup/newspaper-post.png
diff --git a/screenshots/backup/newspaper.png b/screenshots/backup/newspaper.png
diff --git a/screenshots/backup/outline-post.png b/screenshots/backup/outline-post.png
diff --git a/screenshots/backup/outline.png b/screenshots/backup/outline.png
diff --git a/screenshots/feeling-blue.png b/screenshots/feeling-blue.png