chore: v2.3.4

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.3.4](https://github.com/defi-wonderland/smock/compare/v2.3.1...v2.3.4) (2022-11-07)
+
+
+### Bug Fixes
+
+* change markdown output variant ([#173](https://github.com/defi-wonderland/smock/issues/173)) ([e90e158](https://github.com/defi-wonderland/smock/commit/e90e158f1d652383ea8137e1afcd1f65e2bb42c3))
+
 ### [2.3.3](https://github.com/defi-wonderland/smock/compare/v2.3.1...v2.3.3) (2022-10-21)
 
 ### [2.3.1](https://github.com/defi-wonderland/smock/compare/v2.1.0...v2.3.1) (2022-09-28)

README.md

@@ -2,23 +2,22 @@
 
 [![image](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.com/invite/22RQcJjau9)
 
-```{=html}
 <div align="center">
     <a href="https://github.com/defi-wonderland/smock">
         <img src="https://user-images.githubusercontent.com/14298799/128897259-1d2c43b5-9156-425e-82e0-ab13f259e57c.gif" width="400px">
     </a>
 </div>
 <br />
 <br />
-```
-**Smock** is the **S**olidity **mock**ing library. It\'s a plugin for
+
+**Smock** is the **S**olidity **mock**ing library. It's a plugin for
 [hardhat](https://hardhat.org) that can be used to create mock Solidity
-contracts entirely in JavaScript (or TypeScript!). With Smock, it\'s
-easier than ever to test your smart contracts. You\'ll never have to
+contracts entirely in JavaScript (or TypeScript!). With Smock, it's
+easier than ever to test your smart contracts. You'll never have to
 write another mock contract in Solidity again.
 
 Smock is inspired by [sinon](https://sinonjs.org),
-[sinon-chai](https://www.chaijs.com/plugins/sinon-chai), and Python\'s
+[sinon-chai](https://www.chaijs.com/plugins/sinon-chai), and Python's
 [unittest.mock](https://docs.python.org/3/library/unittest.mock.html).
 Although Smock is currently only compatible with
 [hardhat](https://hardhat.org), we plan to extend support to other
@@ -29,15 +28,15 @@ If you wanna chat about the future of Solidity Mocking, join our
 
 # Features
 
--   Get rid of your folder of \"mock\" contracts and **just use
-    JavaScript**.
--   Keep your tests **simple** with a sweet set of chai matchers.
--   Fully compatible with TypeScript and TypeChain.
--   Manipulate the behavior of functions on the fly with **fakes**.
--   Modify functions and internal variables of a real contract with
-    **mocks**.
--   Make **assertions** about calls, call arguments, and call counts.
--   We\'ve got extensive documentation and a complete test suite.
+- Get rid of your folder of "mock" contracts and **just use
+  JavaScript**.
+- Keep your tests **simple** with a sweet set of chai matchers.
+- Fully compatible with TypeScript and TypeChain.
+- Manipulate the behavior of functions on the fly with **fakes**.
+- Modify functions and internal variables of a real contract with
+  **mocks**.
+- Make **assertions** about calls, call arguments, and call counts.
+- We've got extensive documentation and a complete test suite.
 
 # Documentation
 
@@ -56,8 +55,8 @@ npm install @defi-wonderland/smock
 
 ## Basic Usage
 
-Smock is dead simple to use. Here\'s a basic example of how you might
-use it to streamline your tests.
+Smock is dead simple to use. Here's a basic example of how you might use
+it to streamline your tests.
 
 ``` typescript
 ...

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defi-wonderland/smock",
-  "version": "2.3.3",
+  "version": "2.3.4",
   "description": "The Solidity mocking library",
   "keywords": [
     "ethereum",
@@ -39,7 +39,7 @@
     "test": "yarn compile && yarn test:nocompile",
     "lint:check": "cross-env solhint 'contracts/**/*.sol' 'interfaces/**/*.sol' && cross-env prettier --check './**'",
     "lint:fix": "sort-package-json && cross-env prettier --write './**' && cross-env solhint --fix 'contracts/**/*.sol' 'interfaces/**/*.sol'",
-    "docs:md": "pandoc README.rst -f rst -t markdown -o README.md",
+    "docs:md": "pandoc README.rst -f rst -t gfm -o README.md",
     "prepare": "husky install",
     "release": "yarn build && yarn docs:md && standard-version",
     "pre-release": "yarn build && standard-version --prerelease rc",