# Access package documentation in REPL

**URL:** <https://discourse.julialang.org/t/access-package-documentation-in-repl/51262>\
**Category:** General Usage\
**Tags:** question\
**Created:** [December 4, 2020, 4:44pm UTC](https://discourse.julialang.org/t/access-package-documentation-in-repl/51262 "2020-12-04T16:44:26Z")\
**Posts on this page:** 1\
**Showing post:** 7

<div class="post-metadata">

**Author:** ![Tamas\_Papp](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/tamas_papp/32/25949_2.png) [@Tamas\_Papp](https://discourse.julialang.org/u/Tamas_Papp)\
**Post date:** [December 7, 2020, 8:09am UTC](https://discourse.julialang.org/t/access-package-documentation-in-repl/51262/7 "2020-12-07T08:09:47Z")

</div>

I saw this trick for including the REAMDE as a docstring in @tkf’s packages:

> [@Plea to package developers regarding documentation!](https://discourse.julialang.org/t/plea-to-package-developers-regarding-documentation/37473/6):
>
> I usually put a badge like this [[GitHub commits since tagged version]](https://github.com/tkf/BangBang.jl) in README with [![GitHub commits since tagged version](https://img.shields.io/github/commits-since/USER/PACKAGE.jl/vX.Y.Z.svg?style=social&logo=github)](https://github.com/USER/PACKAGE.jl) and then use it as the docstring of the module by this one-linear @doc read(joinpath(dirname(@\_\_DIR\_\_), "README.md"), String) PACKAGE so that the badge is included in the documentation (e.g., [https://tkf.github.io/BangBang.jl/dev/#BangBa…](https://tkf.github.io/BangBang.jl/dev/#BangBang.BangBang)

---

_[View the full topic](https://discourse.julialang.org/t/access-package-documentation-in-repl/51262)._