Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Isaac-Flath committed Nov 29, 2024
1 parent b98cdcf commit de2be1c
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 9 deletions.
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# Fh-FrankenUI


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

> [!WARNING]
>
> This library is still in active development, however there are many
> great things you can do with it already. We’d really like you try to
> it and tell us how it works for you!
> it and tell us how it works for you - but please be aware there will
> improvements to the API over time
## Installation

To install this library, uses

`pip install git+https://github.com/AnswerDotAI/fh-frankenui.git`

Check out the docs [here](https://fh-frankenui.answer.ai/)
`pip install fh-frankenui`

## Getting Started

Expand All @@ -28,14 +30,26 @@ from fh_frankenui.core import *
2. Instantiate the app with the fh-frankenui headers

``` python
app = FastHTML(hdrs=Theme.slate.headers())
app = FastHTML(hdrs=Theme.blue.headers())

# Alternatively, using the fast_app method
app, rt = fast_app(pico=False, hdrs=Theme.slate.headers())
```

> *The color option can be any of the theme options available out of the box*
> *The color option can be any of the theme options available out of the
> box*
From here, you can explore the API Reference & examples to see how to
implement the components. You can also check out these demo videos to as
a quick start guide:

- Fh-Frankenui [documentation page and Tutorial
app](https://fh-frankenui.answer.ai/tutorial_app)
- The [AnswerAI Dev Chat](https://www.youtube.com/watch?v=K5FFPHlWMiY)
where Isaac & Jeremy explore the framework
- This
[video](https://www.loom.com/share/0916e8a95d524c43a4d100ee85157624?sid=9be07e55-c962-4dbd-978c-aa6a0bcee7b3)
where Isaac iteratively builds a form in 5 minutes with the framework

More resources and improvements to the documentation will be added here
soon!
5 changes: 3 additions & 2 deletions nbs/index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"\n",
"To install this library, uses\n",
"\n",
"`pip install git+https://github.com/AnswerDotAI/fh-frankenui.git`\n",
"`pip install fh-frankenui`\n",
"\n",
"## Getting Started\n",
"\n",
Expand All @@ -37,7 +37,7 @@
"2. Instantiate the app with the fh-frankenui headers\n",
"\n",
"```python\n",
"app = FastHTML(hdrs=Theme.slate.headers())\n",
"app = FastHTML(hdrs=Theme.blue.headers())\n",
"\n",
"# Alternatively, using the fast_app method\n",
"app, rt = fast_app(pico=False, hdrs=Theme.slate.headers())\n",
Expand All @@ -46,6 +46,7 @@
"\n",
"From here, you can explore the API Reference & examples to see how to implement the components. You can also check out these demo videos to as a quick start guide:\n",
"\n",
"+ Fh-Frankenui [documentation page and Tutorial app](https://fh-frankenui.answer.ai/tutorial_app)\n",
"+ The [AnswerAI Dev Chat](https://www.youtube.com/watch?v=K5FFPHlWMiY) where Isaac & Jeremy explore the framework\n",
"+ This [video](https://www.loom.com/share/0916e8a95d524c43a4d100ee85157624?sid=9be07e55-c962-4dbd-978c-aa6a0bcee7b3) where Isaac iteratively builds a form in 5 minutes with the framework\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion settings.ini
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
### Python library ###
repo = fh-frankenui
lib_name = %(repo)s
version = 0.0.3
version = 0.0.4
min_python = 3.7
license = apache2
black_formatting = False
Expand Down

0 comments on commit de2be1c

Please sign in to comment.