Skip to content

Commit

Permalink
[nop] Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ptaoussanis committed Jul 31, 2023
1 parent 93d89b7 commit 11b026e
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<a href="https://www.taoensso.com" title="More stuff by @ptaoussanis at www.taoensso.com">
<img src="https://www.taoensso.com/taoensso-open-source.png" alt="Taoensso open-source" width="400"/></a>
<img src="https://www.taoensso.com/taoensso-open-source.png" alt="Taoensso open-source" width="350"/></a>

**[CHANGELOG]** | [API] | current [Break Version]:
**[CHANGELOG][]** | [API][] | current [Break Version][]:

```clojure
[com.taoensso/tempura "1.5.3"] ; See CHANGELOG for details
```

> See [here](https://taoensso.com/clojure/backers) if you're interested in helping support my open-source work, thanks! - Peter Taoussanis
> See [here][backers] if to help support my open-source work, thanks! - [Peter Taoussanis][Taoensso.com]
# Tempura: a pure Clojure/Script i18n translations library

## Objectives

* Tiny (**single fn**), **cross-platform all-Clojure API** for providing multilingual content.
* Match [gettext]'s convenience for **embedding default content** directly in code (optional).
* Match [gettext][]'s convenience for **embedding default content** directly in code (optional).
* Exceed `gettext`'s ability to handle **versioned content** through unique content ids.
* Work out-the-box with plain text, Hiccup, **Reactjs**, ...
* Easy, optional platform-appropriate support for simple **Markdown styles**.
Expand Down Expand Up @@ -68,7 +68,7 @@

```

See the [wiki docs] for a more detailed discussion of Tempura's resource search behaviour.
See the [wiki docs][] for a more detailed discussion of Tempura's resource search behaviour.

## Quickstart

Expand Down Expand Up @@ -153,7 +153,7 @@ And we're ready to go:
(tr [:example/invalid [:div "My **fallback** div"]]) ; => [:div "My " [:strong "fallback"] " div"]
```

And that's it, you know the [API]:
And that's it, you know the [API][]:

```clojure
(tr [opts locales resource-ids]) ; Without argument interpolation, or
Expand Down Expand Up @@ -196,7 +196,7 @@ I'll note that since the API is so pleasant, it's actually often much _less_ eff
If it's easy to use, it'll be easy to get your developers in the habit of writing content this way - which means that there's a trivial path to adding multilingual support whenever it makes sense to do so.

> See also the [wiki docs] for more info.
> See also the [wiki docs][] for more info.
## FAQ

Expand All @@ -218,7 +218,7 @@ As an example:

So performance is often on par with the best possible hand-optimized monolingual code.

#### How would you use this with [Reagent], etc.?
#### How would you use this with [Reagent][], etc.?

Tempura was specifically designed to work with Reactjs applications, and works great with Reagent out-the-box.

Expand All @@ -240,23 +240,21 @@ Shouldn't be hard to do, you'll just need a conversion tool to/from edn. Haven't

## Contacting me / contributions

Please use the project's [GitHub issues page] for all questions, ideas, etc. **Pull requests welcome**. See the project's [GitHub contributors page] for a list of contributors.
Please use the project's [GitHub issues page][] for all questions, ideas, etc. **Pull requests welcome**. See the project's [GitHub contributors page][] for a list of contributors.

Otherwise, you can reach me at [Taoensso.com]. Happy hacking!
Otherwise, you can reach me at [Taoensso.com][]. Happy hacking!

\- [Peter Taoussanis]
\- [Peter Taoussanis][Taoensso.com]

## License

Distributed under the [EPL v1.0] \(same as Clojure).
Copyright &copy; 2016-2022 [Peter Taoussanis].
Distributed under the [EPL v1.0][] \(same as Clojure).
Copyright &copy; 2016-2022 [Peter Taoussanis][Taoensso.com].

<!--- Standard links -->
[Taoensso.com]: https://www.taoensso.com
[Peter Taoussanis]: https://www.taoensso.com
[@ptaoussanis]: https://www.taoensso.com
[More by @ptaoussanis]: https://www.taoensso.com
[Break Version]: https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md
[backers]: https://taoensso.com/clojure/backers

<!--- Standard links (repo specific) -->
[CHANGELOG]: https://github.com/ptaoussanis/tempura/releases
Expand Down

0 comments on commit 11b026e

Please sign in to comment.