Skip to content

Commit c8a4c6a

Browse files
committed
Add project information to README
1 parent 2bfce48 commit c8a4c6a

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,33 @@
11
# Duct REPL Refers [![Build Status](https://github.com/duct-framework/repl.refers/actions/workflows/test.yml/badge.svg)](https://github.com/duct-framework/repl.refers/actions/workflows/test.yml)
22

3-
A Clojure library designed to ... well, that part is up to you.
3+
[Integrant][] methods for adding functions to the `user` namespace.
4+
Used by [Duct][] modules to add useful development functions to the
5+
REPL.
6+
7+
[integrant]: https://github.com/weavejester/integrant
8+
[duct]: https://github.com/duct-framework/duct
9+
10+
## Installation
11+
12+
Add the following dependency to your deps.edn file:
13+
14+
org.duct-framework/repl.refers {:mvn/version "0.1.0-SNAPSHOT"}
15+
16+
Or to your Leiningen project file:
17+
18+
[org.duct-framework/repl.refers "0.1.0-SNAPSHOT"]
419

520
## Usage
621

7-
FIXME
22+
To use, add the `:duct.repl/refers` key to your configuration with a map
23+
of aliases to fully-qualified symbols. For example:
24+
25+
```edn
26+
{:duct.repl/refers {trim clojure.string/trim}}
27+
```
28+
29+
When the configuration is initiated, `trim` will be added to the `user`
30+
namespace. When the running system is halted, `trim` will be removed.
831

932
## License
1033

0 commit comments

Comments
 (0)