Skip to content

Commit

Permalink
Issue #46: Change the version and describe features in the informatio…
Browse files Browse the repository at this point in the history
…n file
  • Loading branch information
lexhouk committed Oct 15, 2024
1 parent 86627d8 commit 1d7a7c7
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 2 deletions.
41 changes: 40 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,44 @@
```
____ _ _ _ _ _
| _ \ ___ _ __ ___ ___ _ __ __ _| | / \ ___ ___(_)___| |_ __ _ _ __ | |_
| |_) / _ \ '__/ __|/ _ \| '_ \ / _` | | / _ \ / __/ __| / __| __/ _` | '_ \| __|
| __/ __/ | \__ \ (_) | | | | (_| | | / ___ \\__ \__ \ \__ \ || (_| | | | | |_
|_| \___|_| |___/\___/|_| |_|\__,_|_| /_/ \_\___/___/_|___/\__\__,_|_| |_|\__|
```

# Personal Assistant

It assists you in organizing the phone book, creating notes, and more.
This web application offers a comprehensive suite of features for managing
contacts, notes, and files, all integrated with a powerful tagging system for
enhanced organization and search capabilities. It also provides up-to-date news
and currency exchange rates, ensuring users have access to real-time
information. With robust user authentication and personalized data access, the
application ensures a secure and customized experience, while utilizing cloud
storage and caching for optimal performance.


## Features

- **Contacts:** Allows users to manage their contact list with CRUD operations,
including organizing by birthdays and searching by name.

- **Tags:** Enables users to create and delete tags, with restrictions on
deletion if the tag is in use, and shared across all users.

- **Notes:** Provides a simple note-taking feature with title and description,
enhanced by tag-based categorization and advanced search functionality.

- **Files:** Allows file uploads and viewing, securely storing content in the
cloud and enabling filtering and sorting via a tag-like system.

- **News:** Displays global news and currency exchange rates, with real-time
data and a caching system for faster load times, including a
superuser-controlled data sync.

- **Users:** Manages user authentication, including registration, login, and
password recovery, ensuring personalized access to data and features while
protecting against spam accounts.


## Installation

Expand All @@ -18,6 +56,7 @@ $ python manage.py migrate
$ python manage.py createsuperuser
```


## Usage

```bash
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "personal-assistant"
version = "0.18.0"
version = "1.0.0"
description = "It assists you in organizing the phone book, creating notes, and more."
authors = [
"Boris Zdorovets <bor.zdorovets28@gmail.com>",
Expand Down

0 comments on commit 1d7a7c7

Please sign in to comment.