Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AbhinavOmprakash committed Oct 18, 2021
1 parent 9d03985 commit a1fef21
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ pom.xml.asc
/.nrepl-port
.hgignore
.hg/
.idea
.idea
/scratch.txt
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# luna
[![Clojars Project](https://img.shields.io/clojars/v/org.clojars.abhinav/luna.svg)](https://clojars.org/org.clojars.abhinav/luna)

No more regrets, wield the power of regex with the readability of English with luna.

Expand All @@ -11,6 +12,20 @@ Beta but don't let this discourage you from using it, it has a good test suite a

Readable code can be hard to maintain. Unreadable code can be impossible to maintain.

# Installing and Using
add this to your project.clj file
```clojure
:dependencies [[org.clojars.abhinav/luna "0.1.0-SNAPSHOT"]]
```
Luna has one function `pre` that does the heavy lifting.
```clojure
;; import it
(ns user.core
(:require [luna.core :as luna]))

(luna/pre [:match ["x" :digits :atleast 4] :when :at-start])
;;=> #"^x\d{4,}"
```
# Contributing

I welcome contributions, even from first-timers. Feedbacks and suggestions are welcome too.
Expand Down

0 comments on commit a1fef21

Please sign in to comment.