Skip to content

Commit

Permalink
Merge pull request #67 from lowks/lowks-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
lowks authored Sep 15, 2017
2 parents d00b043 + 6709d52 commit 3592ed6
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ A library for dealing with paths in Elixir largely inspired by Python's pathlib.

To use Radpath, add a dependency in your mix:

```
```console
def deps do
[ { :Radpath, github: "lowks/Radpath"}]
end
Expand All @@ -32,45 +31,45 @@ Developed whenever I can find the time.

Running tests against a stable release of Elixir defined by 'STABLE_ELIXIR_VERSION' in the Makefile:

```
```console
make ci
```

Running tests against your system's Elixir:

```
```console
make
```

## Docs (Lite Version)

To list down files in a path:

```
```console
Radpath.files("/home/lowks/Documents")
```

or if you wanted to filter out certain files with pdf extensions:

```
```console
Radpath.files("/home/lowks/Documents", "pdf")
```

Listing down only directories:

```
```console
Radpath.dirs("/home/lowks")
```

To create symlink:

```
```console
Radpath.symlink(source, destination)
```

To create tempfile:

```
```console
{status, fd, file_path} = Radpath.mktempfile
IO.write fd, "hoho"
File.close fd
Expand All @@ -83,7 +82,7 @@ This uses all the defaults

To customize the location plus the extension:

```
```console
{_, fd, filepath} = Radpath.mktempfile(".log", "/home/lowks/Downloads")
IO.write fd, "hoho"
File.read! filepath
Expand Down

0 comments on commit 3592ed6

Please sign in to comment.