Skip to content

Commit a4c4c91

Browse files
committed
update readme
1 parent 0d0f2f0 commit a4c4c91

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,29 @@
33
[![Package Version](https://img.shields.io/hexpm/v/simplifile)](https://hex.pm/packages/simplifile)
44
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/simplifile/)
55

6-
Simplifile provides synchronous operations for working with files and directories that work for all
7-
non-browser targets (Erlang, Node, Deno, and Bun).
6+
Simplifile provides synchronous operations for working with files and directories that work for all
7+
non-browser targets (Erlang, Node, Deno, and Bun).
88

99
## When should I use `simplifile`?
1010

11-
Simplifile makes a simple tradeoff: it confines itself to a subset of purely synchronous file/directory utilities
11+
Simplifile makes a simple tradeoff: it confines itself to a subset of purely synchronous file/directory utilities
1212
so that it can have one API for all targets. Erlang and JavaScript have fundamentally different concurrency
1313
models, so bindings to async code will simply be different for different targets.
1414

15-
You *should* use simplifile if
15+
You *should* use simplifile if
1616
1. The same code running on JS and Erlang targets is important
1717
2. Sync file operations will not be a major performance bottleneck (dev tooling, configuration, scripting, etc.)
1818
3. You just wanna do some basic file operations and get on with life
1919

2020
If you think you need a different solutions, these projects may be helpful:
21-
[File streams (erlang target)](https://github.com/richard-viney/file_streams)
21+
[File streams](https://github.com/richard-viney/file_streams)
2222

2323
## Upgrading to 2.0
2424

2525
Please consult the changelog, but basically:
2626
The deprecated `is_file`, `is_directory` functions have been removed.
2727
The `verify_is_file`, `verify_is_directory`, and `verify_is_symlink` have had their verify_ prefixes removed (now `is_file`, `is_directory`, `is_symlink` respectively).
28-
The `Unknown` variant of `FileError` now has an inner `String`.
28+
The `Unknown` variant of `FileError` now has an inner `String`.
2929

3030
## Example
3131
```gleam

0 commit comments

Comments
 (0)