Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
niwinz committed Nov 13, 2022
1 parent dbfc44e commit 588c112
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 35 deletions.
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,38 @@

A promise library & concurrency toolkit for Clojure and ClojureScript.

This library exposes a bunch of usefull syntactic abstractions that
will considerably simplify to work with promises (in a very similar
way as you will do it in JS with async/await).
This library exposes a bunch of usefull syntactic abstractions that will considerably simplify to
work with promises (in a very similar way as you will do it in JS with async/await) and many helpers
from executors to concurrency patterns (bulkhead & CSP).

Here you have the [User Guide][0] and the [API documentation][1].
Here you can look a detailed [documentation][1].


## Getting Started

deps.edn:

```clojure
funcool/promesa {:mvn/version "9.1.536"}
```

Leiningen:

```clojure
[funcool/promesa "9.1.536"]
```

## On the REPL

```clojure
(require '[promesa.core :as p])

(->> (p/promise 1)
(p/map inc)
(deref)
;; => 2
```

## Contributing

If you miss something, feel free to open an issue for a discussion. If
Expand All @@ -32,5 +57,4 @@ npm install
npm test
```

[0]: https://funcool.github.io/promesa/latest/user-guide.html
[1]: https://funcool.github.io/promesa/latest/
3 changes: 1 addition & 2 deletions doc.clj
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@
:source-paths ["src"]
:namespaces [#"^promesa\."]
:doc-files
["doc/intro.md"
"doc/promises.md"
["doc/promises.md"
"doc/executors.md"
"doc/channels.md"
"doc/bulkhead.md"
Expand Down
28 changes: 0 additions & 28 deletions doc/intro.md

This file was deleted.

0 comments on commit 588c112

Please sign in to comment.