Skip to content

Commit

Permalink
refactor: README.md TODOs
Browse files Browse the repository at this point in the history
  • Loading branch information
Hi-kue committed Jun 7, 2024
1 parent a03a802 commit 7916d19
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<img src="./assets/pycrypt-logo.png" alt="Pycrypt Logo" height="200">
</a>

<h3 align="center">PyCrypt - Ai Prediction Engine</h3>
<h3 align="center">PyCrypt - AI Prediction Engine</h3>

<p align="center">
PyCrypt is a Flask application that uses machine learning to provide
Expand Down Expand Up @@ -43,11 +43,21 @@
</div>
<br />

## Table of Contents

> [!WARNING]
> This project is still in `development` and is not yet ready for use, if you are looking to become a contributing member of this project refer to the [Contributing](#contributing) section for more information.
## Table of Contents

- [Table of Contents](#table-of-contents)
- [TODOs \& Potential Features](#todos--potential-features)
- [About The Project](#about-the-project)
- [Installation \& Usage](#installation--usage)
- [Features](#features)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)

## TODOs & Potential Features

Information about the project, including some potential features to include, and some TODOs that we need to complete can be found in [this](./TODOs.md) file.
Expand All @@ -58,14 +68,24 @@ PyCrypt (A very generic name) is a machine learning prediction and processing en

## Installation & Usage

// TODO

## Features

// TODO

## Contributing

![Pycrypt-Contrib](https://repobeats.axiom.co/api/embed/a45085a1ae2c5e4c7c28dd4bbe775aa933d41c5d.svg "Pycrypt Contributors")

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

## Contact

## Acknowledgements
// TODO

## Acknowledgements

// TODO

0 comments on commit 7916d19

Please sign in to comment.