Skip to content

Commit

Permalink
chore: bump package version and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Alfonso Reyes committed Aug 27, 2020
1 parent 901c52c commit 57a9f5c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ await RedocModule.setup('/docs', app, document, redocOptions);
| Option | Description | Type | Note |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------------ |
| title | Web site title (e.g: ReDoc documentation) | string |
| favicon | Web site favicon URL | string | Fallbacks to the document title if not set |
| favicon | Web site favicon URL | string | Fallbacks to the document title if not set |
| logo | Logo Options | LogoOptions | See LogoOptions table |
| theme | Theme options | ThemeOptions | See ThemeOptions info |
| untrustedSpec | If set, the spec is considered untrusted and all HTML/markdown is sanitized to prevent XSS, by default is false | boolean |
Expand Down Expand Up @@ -118,7 +118,8 @@ Apply the properties defined in ResolvedThemeInterface to the key called "theme"

## 👨‍💻👩‍💻 Contributors

Special thanks to [Jay McDoniel (jmcdo29)](https://github.com/jmcdo29) who helped with code refactoring and unit tests! 👏
- Special thanks to [Jay McDoniel (jmcdo29)](https://github.com/jmcdo29) who helped with code refactoring and unit tests! 👏
- @joemaidman

## 📜 Changelog

Expand All @@ -129,6 +130,7 @@ Bellow are a list of changes, some might go undocumented
- 1.2.0 - Added unit tests, refactored code
- 1.2.1 - Updated to work with the latest version of nest swagger module
- 1.2.2 - Fixed issue with URL on windows
- 1.3.0 - Added favicon option (by @joemaidman)

## 📋 ToDo

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "nestjs-redoc",
"version": "1.2.2",
"version": "1.3.0",
"description": "NestJS ReDoc frontend",
"repository": "[email protected]:mxarc/nestjs-redoc.git",
"author": "Alfonso Reyes",
Expand Down

0 comments on commit 57a9f5c

Please sign in to comment.