Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readme edits #37

Merged
merged 3 commits into from
Sep 27, 2022
Merged

Readme edits #37

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
666785c
added gif, made slight changes to wording
sfc-gh-trichards Sep 27, 2022
893333f
removed whitespace
tylerjrichards Sep 27, 2022
ab0d40c
changed back to using pip
tylerjrichards Sep 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@

## Highlights

- 📙&nbsp; <b>Discover:</b> Visit the gallery <a href="https://extras.streamlitapp.com">extras.streamlitapp.com</a> to discover all extras in their natural habitat
- 📙&nbsp; <b>Discover:</b> Visit the gallery <a href="https://extras.streamlitapp.com">extras.streamlitapp.com</a> to discover all extras in their natural habitat.
- 🛝&nbsp; <b>Try:</b> The gallery comes with a Streamlit-based playground for some extras. Try it before you <strike>buy</strike> install it!
- ⬇️&nbsp; <b>Install:</b> `streamlit-extras` is a PyPI package with all extras included. Catch them all using pip!
- 🫴&nbsp; <b>Share:</b> Go ahead and share your own extras, it's just a PR away!
- ⬇️&nbsp; <b>Install:</b> `streamlit-extras` is a PyPI package with all extras included. Get them all using pip!
- 🫴&nbsp; <b>Share:</b> Go ahead and share your own extras, it's just [a PR away](https://extras.streamlitapp.com/Contribute)!

## Getting Started

Expand All @@ -44,9 +44,14 @@ Here's an example with one of the easiest extras around, <a href="https://extras
```python
from streamlit_extras.stoggle import stoggle

stoggle("Summary", "More content that's hidden by default!")
stoggle(
"Click me!",
"""🥷 Surprise! Here's some additional content""",
)
```

<img src="https://user-images.githubusercontent.com/16867691/192553812-f91c801b-e820-470b-84c6-4563504c6ce5.gif"></img>

## Documentation

Visit <a href="https://extras.streamlitapp.com">extras.streamlitapp.com</a>
Expand Down