瀏覽代碼

chore: run prettier over Markdown files

Paul Razvan Berg 2 年之前
父節點
當前提交
01312cd5aa
共有 2 個文件被更改,包括 28 次插入26 次删除
  1. 10 15
      LICENSE.md
  2. 18 11
      README.md

+ 10 - 15
LICENSE.md

@@ -2,20 +2,15 @@ MIT License
 
 Copyright (c) 2022 Paul Razvan Berg
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ 18 - 11
README.md

@@ -25,10 +25,12 @@ create a new repository with this repo as the initial state.
 
 ## Features
 
-This template builds upon the frameworks and libraries mentioned above, so for details about their specific features, please consult their respective documentations.
+This template builds upon the frameworks and libraries mentioned above, so for details about their specific features,
+please consult their respective documentations.
 
-For example, for Hardhat, you can refer to the [Hardhat Tutorial](https://hardhat.org/tutorial) and the [Hardhat
-Docs](https://hardhat.org/docs). You might be in particular interested in reading the [Testing Contracts](https://hardhat.org/tutorial/testing-contracts) section.
+For example, for Hardhat, you can refer to the [Hardhat Tutorial](https://hardhat.org/tutorial) and the
+[Hardhat Docs](https://hardhat.org/docs). You might be in particular interested in reading the
+[Testing Contracts](https://hardhat.org/tutorial/testing-contracts) section.
 
 ### Sensible Defaults
 
@@ -60,20 +62,23 @@ You can edit the CI script in [.github/workflows/ci.yml](./.github/workflows/ci.
 
 ### Conventional Commits
 
-This template enforces the [Conventional Commits](https://www.conventionalcommits.org/) standard for git commit messages.
-This is a lightweight convention that creates an explicit commit history, which makes it easier to write automated
-tools on top of.
+This template enforces the [Conventional Commits](https://www.conventionalcommits.org/) standard for git commit
+messages. This is a lightweight convention that creates an explicit commit history, which makes it easier to write
+automated tools on top of.
 
 ### Git Hooks
 
-This template uses [Husky](https://github.com/typicode/husky) to run automated checks on commit messages, and [Lint Staged](https://github.com/okonet/lint-staged) to automatically format the code with Prettier when making a git commit.
+This template uses [Husky](https://github.com/typicode/husky) to run automated checks on commit messages, and
+[Lint Staged](https://github.com/okonet/lint-staged) to automatically format the code with Prettier when making a git
+commit.
 
 ## Usage
 
 ### Pre Requisites
 
-Before being able to run any command, you need to create a `.env` file and set a BIP-39 compatible mnemonic as an environment
-variable. You can follow the example in `.env.example`. If you don't already have a mnemonic, you can use this [website](https://iancoleman.io/bip39/) to generate one.
+Before being able to run any command, you need to create a `.env` file and set a BIP-39 compatible mnemonic as an
+environment variable. You can follow the example in `.env.example`. If you don't already have a mnemonic, you can use
+this [website](https://iancoleman.io/bip39/) to generate one.
 
 Then, proceed with installing dependencies:
 
@@ -157,13 +162,15 @@ $ yarn deploy --greeting "Bonjour, le monde!"
 
 ### Syntax Highlighting
 
-If you use VSCode, you can get Solidity syntax highlighting with the [hardhat-solidity](https://marketplace.visualstudio.com/items?itemName=NomicFoundation.hardhat-solidity) extension.
+If you use VSCode, you can get Solidity syntax highlighting with the
+[hardhat-solidity](https://marketplace.visualstudio.com/items?itemName=NomicFoundation.hardhat-solidity) extension.
 
 ## Using GitPod
 
 [GitPod](https://www.gitpod.io/) is an open-source developer platform for remote development.
 
-To view the coverage report generated by `yarn coverage`, just click `Go Live` from the status bar to turn the server on/off.
+To view the coverage report generated by `yarn coverage`, just click `Go Live` from the status bar to turn the server
+on/off.
 
 ## License