Skip to content

Commit

Permalink
Fix readme links and rendering
Browse files Browse the repository at this point in the history
ghstack-source-id: 37f5ca6ea09c6319a357d261b6ec1f52573f79a6
Pull Request resolved: #191
  • Loading branch information
amyreese committed Feb 22, 2024
1 parent 05e4585 commit 9fe7740
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Safe, atomic formatting with [black][] and [µsort][]
[![license](https://img.shields.io/pypi/l/ufmt.svg)](https://github.com/omnilib/ufmt/blob/master/LICENSE)
[![vscode extension](https://img.shields.io/badge/vscode-extension-007ACC?logo=visualstudiocode)](https://marketplace.visualstudio.com/items?itemName=omnilib.ufmt)

µfmt is a safe, atomic code formatter for Python built on top of [black] and [µsort]:
µfmt is a safe, atomic code formatter for Python built on top of [black][] and [µsort][]:

> Black makes code review faster by producing the smallest diffs possible. Blackened code looks the same regardless of the project you’re reading.
Expand Down Expand Up @@ -67,6 +67,9 @@ $ ufmt diff <path> [<path> ...]
Integrations
------------

See the [user guide](https://ufmt.omnilib.dev/en/latest/guide.html#integrations)
for details on each integration.

### GitHub Actions

µfmt provides a GitHub Action that can be added to an existing workflow,
Expand All @@ -84,8 +87,6 @@ jobs:
python-version: "3.x"
```
See the [user guide](https://ufmt.omnilib.dev/en/latest/guide.html#github-actions) for details.
### pre-commit hook
µfmt provides a [pre-commit][] hook. To format your diff before
Expand All @@ -101,8 +102,6 @@ every commit, add the following to your `.pre-commit-config.yaml` file:
- usort == 1.0.4
```

See the [user guide](https://ufmt.omnilib.dev/en/latest/guide.html#pre-commit) for details.

### Visual Studio Code

µfmt has an official VS Code extension to use µfmt as a formatter for Python files.
Expand All @@ -125,14 +124,14 @@ Once installed, µfmt can be set as the default formatter with the following set

For more details, or to install the extension, see the Visual Studio Marketplace page:

<a href="https://marketplace.visualstudio.com/items?itemName=omnilib.ufmt"><img alt="VS Code extension marketplace" src="https://img.shields.io/badge/VSCode-ufmt-007ACC?style=for-the-badge&logo=visualstudiocode" /></a>
<a href="vscode:extension/omnilib.ufmt"><img alt="Install VS Code extension now" src="https://img.shields.io/badge/-Install%20Now-107C10?style=for-the-badge&logo=visualstudiocode" /></a>
[![VS Code extension marketplace](https://img.shields.io/badge/VSCode-ufmt-007ACC?style=for-the-badge&logo=visualstudiocode)](https://marketplace.visualstudio.com/items?itemName=omnilib.ufmt)
[![Install VS Code extension now](https://img.shields.io/badge/-Install%20Now-107C10?style=for-the-badge&logo=visualstudiocode)](vscode:extension/omnilib.ufmt)


License
-------

µfmt is copyright [Amethyst Reese](https://noswap.com), and licensed under
ufmt is copyright [Amethyst Reese](https://noswap.com), and licensed under
the MIT license. I am providing code in this repository to you under an open
source license. This is my personal repository; the license you receive to
my code is from me and not from my employer. See the `LICENSE` file for details.
Expand Down

0 comments on commit 9fe7740

Please sign in to comment.