Skip to content

Commit

Permalink
Renamed the README.md to index.md for proper usage.
Browse files Browse the repository at this point in the history
  • Loading branch information
TonyKaravasilev committed Apr 9, 2019
1 parent 5c884b9 commit e6e0395
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md → index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CryptoMañana Framework Documentation

[![Open Source](https://img.shields.io/badge/Open%20Source-FREE-success.svg?style=flat-square&cacheSeconds=7200)](https://en.wikipedia.org/wiki/Open-source_software)
[![License](https://img.shields.io/github/license/TonyKaravasilev/CryptoMananaDocs.svg?color=important&label=License&style=flat-square&cacheSeconds=7200)](https://github.com/TonyKaravasilev/CryptoMananaDocs/blob/master/LICENSE)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2604693.svg)](https://doi.org/10.5281/zenodo.2604693)
Expand All @@ -8,26 +8,26 @@

**See Source:** [Project Repository](https://github.com/TonyKaravasilev/CryptoManana){:target="_blank"}

# Project Description
## Project Description
CryptoMañana (CryptoManana) is a PHP cryptography framework that provides object-oriented solutions for boosting your project's security.
The code base of the project follows the S.O.L.I.D principles and implements a few popular Software Design Patterns.
It is very useful for secure hashing, encryption, random data generation and even more.
CryptoMañana is here to make your development faster and more secure!

**Developer: [Tony Karavasilev](http:https://karavasilev.info)**

## Project Installation
### Project Installation
```bash
composer require karavasilev/cryptomanana
```

## Project Citation via DOI
### Project Citation via DOI
- **The Framework** - [DOI 10.5281/zenodo.2604693](https://doi.org/10.5281/zenodo.2604693) *(concept)*
- **v0.2.0** - [DOI 10.5281/zenodo.2621937](https://doi.org/10.5281/zenodo.2621937)
- **v0.1.0** - [DOI 10.5281/zenodo.2604329](http:https://doi.org/10.5281/zenodo.2604329)

# The Technical Documentation
## The Technical Documentation
[The API Documentation](api/){:target="_blank"} (generated via PHP Documetor)

# The Framework Documentation
## The Framework Documentation
**@TODO (Coming Soon...)**

0 comments on commit e6e0395

Please sign in to comment.