-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from globophobe/fix/calendar-translation
Update readme
- Loading branch information
Showing
2 changed files
with
42 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,43 @@ | ||
Django Semantic UI forms | ||
------------------------ | ||
|
||
Django forms with [Semantic UI](https://semantic-ui.com/) style. Semantic UI forms may be used both with [django-semantic-admin](https://github.com/globophobe/django-semantic-admin), as well as outside the admin. | ||
|
||
|
||
Why? | ||
---- | ||
|
||
* JavaScript datepicker and timepicker components. | ||
* JavaScript selects, including multiple selections, which integrate well with Django autocomplete fields. | ||
* Semantic UI has libraries for [React](https://react.semantic-ui.com/) and [Vue](https://semantic-ui-vue.github.io/#/), in addition to jQuery. This means you can save time by using django-semantic-forms for simple forms, and use React or Vue for more complicated use cases. | ||
|
||
|
||
Install | ||
------- | ||
|
||
Install from PyPI: | ||
|
||
``` | ||
pip install django-semantic-forms | ||
``` | ||
|
||
Add to `settings.py`: | ||
|
||
```python | ||
INSTALLED_APPS = [ | ||
"semantic_forms", | ||
... | ||
] | ||
``` | ||
|
||
Please remember to run `python manage.py collectstatic` for production deployments. | ||
|
||
This package use [Fomantic UI](https://fomantic-ui.com/) the official community fork of Semantic UI. Please add the Fomantic UI dependencies to your Django template. | ||
|
||
For example: | ||
|
||
``` | ||
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/semantic.min.css"> | ||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.7.1/jquery.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/semantic.min.js"></script> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[tool.poetry] | ||
name = "django-semantic-forms" | ||
version = "0.1.2" | ||
version = "0.1.3" | ||
description = "Django Semantic UI forms" | ||
authors = ["Alex <[email protected]>"] | ||
readme = "README.md" | ||
|