Update README.md

README.md

@@ -1,2 +1,46 @@
-# tommytran.io
-My personal website. <br />
+## WonderMod theme for Hugo - https://olivier.falcoz.net
+
+### What is this?
+This is a fork of the [WonderMod](https://github.com/Wonderfall/hugo-WonderMod.git) theme developed by [Wonderfall](https://github.com/Wonderfall).
+
+### Credits
+- [WonderMod](https://github.com/Wonderfall/hugo-WonderMod.git) by Wonderfall  
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/wonderfall/hugo-WonderMod/master/.github/assets/web-capture.jpeg" title="WonderMod" alt="WonderMod image">
+</p>
+
+### original [README.md ](https://github.com/Wonderfall/hugo-WonderMod/blob/master/README.md)
+
+> WonderMod is a fork itself of an original theme for [Hugo](https://gohugo.io/) called [PaperMod](https://github.com/adityatelange/hugo-PaperMod) (made by adityatelange). Since PaperMod isn't interested in a few changes such as **removing inline JavaScript**, which I personally require to harden my websites, Wonderfall decided to maintain his own fork (he didn't want to keep overwriting a bunch of files as a fork workflow is much cleaner). Don't expect a ton of changes, and unless you know him, you probably don't want to use WonderMod.
+>
+> When implementing new features, Wonderfall tries to do as much as he can with pure CSS code instead of adding new JavaScript code. He'd like to keep the JavaScript part minimal and that's why WonderMod should be totally usable when disabling JavaScript. WonderMod is also designed with strong CSP headers in mind: no inline JavaScript or style, no calls to third-parties.
+>
+> **This fork is regularly synced with upstream changes from [PaperMod](https://github.com/adityatelange/hugo-PaperMod).** A merging workflow was chosen since rebasing WonderMod's changes every time could be less efficient. As such, commit history is a bit messy, but upstream changes will be merged on a best effort basis.
+>
+> ### Main changes
+> Current "main" changes are as follows:
+> - Remove inline JavaScript ([2528906](https://github.com/Wonderfall/hugo-WonderMod/commit/2528906a38a1ca8a50b3e3a74ffcf9a01a0483a7))
+> - Improved YouTube shortcode ([4dc3bee](https://github.com/Wonderfall/hugo-WonderMod/commit/4dc3bee5477b6d22ce830faa13375f4c2e6a216b))
+> - Built-in Chroma instead of client-side syntax highlighting with HLJS ([841141](https://github.com/Wonderfall/hugo-WonderMod/commit/8411411a671785d098ffff9323b064acc0c16cb4))
+> - Responsive Table of Contents with side display support ([2303605](https://github.com/Wonderfall/hugo-WonderMod/commit/230360552b44a8e45496da76ae539a63ad0a3f5a))
+> - Responsive "hamburger" menu for mobile ([723ac4f](https://github.com/Wonderfall/hugo-WonderMod/commit/723ac4f5c68180b816ebf1dce26839fd3db02ab3))
+> - Simple reading progress bar ([13876be](https://github.com/Wonderfall/hugo-WonderMod/commit/13876beb0afd9d535890e82af459e639064650f1))
+> - Bunch of CSS and other changes (see [commit history](https://github.com/Wonderfall/hugo-WonderMod/commits/master))
+>
+> Additional credits:
+> - [PaperModX](https://github.com/reorx/hugo-PaperModX/) by reorx
+>
+> ### Configure
+> Most of the installation process and settings are shared with the original PaperMod, so check out [their documentation](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation). One noticeable difference though is that in order to enable syntax highlighting, you have to add this to your `config.yml` :
+>
+> ```
+> markup:
+>    highlight:
+>        style: dracula
+>        noClasses: false
+>        guessSyntax: true
+> ```
+
+See [Hugo documentation](https://gohugo.io/getting-started/configuration-markup#highlight) for more options.
+*Note: for some reason, the `guessSyntax` doesn't actually work but is required. Please make your code fences explicit for the time being.*