Skip to content

Commit c96ea3f

Browse files
orgurarorgurar
committed
Update README.md
1 parent 5fc99d2 commit c96ea3f

File tree

1 file changed

+40
-187
lines changed

1 file changed

+40
-187
lines changed

‎README.md‎

Lines changed: 40 additions & 187 deletions
Original file line numberDiff line numberDiff line change
@@ -1,214 +1,67 @@
1-
<!--
2-
*** Thanks for checking out the Best-README-Template. If you have a suggestion
3-
*** that would make this better, please fork the repo and create a pull request
4-
*** or simply open an issue with the tag "enhancement".
5-
*** Thanks again! Now go create something AMAZING! :D
6-
-->
7-
8-
9-
10-
<!-- PROJECT SHIELDS -->
11-
<!--
12-
*** I'm using markdown "reference style" links for readability.
13-
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
14-
*** See the bottom of this document for the declaration of the reference variables
15-
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
16-
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
17-
-->
18-
[![Contributors][contributors-shield]][contributors-url]
19-
[![Forks][forks-shield]][forks-url]
20-
[![Stargazers][stars-shield]][stars-url]
21-
[![Issues][issues-shield]][issues-url]
22-
[![MIT License][license-shield]][license-url]
23-
[![LinkedIn][linkedin-shield]][linkedin-url]
24-
25-
26-
27-
<!-- PROJECT LOGO -->
28-
<br />
29-
<p align="center">
30-
<a href="https://github.com/othneildrew/Best-README-Template">
31-
<img src="images/logo.png" alt="Logo" width="80" height="80">
32-
</a>
33-
34-
<h3 align="center">Best-README-Template</h3>
35-
36-
<p align="center">
37-
An awesome README template to jumpstart your projects!
38-
<br />
39-
<a href="https://github.com/othneildrew/Best-README-Template"><strong>Explore the docs »</strong></a>
40-
<br />
41-
<br />
42-
<a href="https://github.com/othneildrew/Best-README-Template">View Demo</a>
43-
·
44-
<a href="https://github.com/othneildrew/Best-README-Template/issues">Report Bug</a>
45-
·
46-
<a href="https://github.com/othneildrew/Best-README-Template/issues">Request Feature</a>
47-
</p>
48-
</p>
49-
50-
51-
52-
<!-- TABLE OF CONTENTS -->
53-
<details open="open">
54-
<summary>Table of Contents</summary>
55-
<ol>
56-
<li>
57-
<a href="#about-the-project">About The Project</a>
58-
<ul>
59-
<li><a href="#built-with">Built With</a></li>
60-
</ul>
61-
</li>
62-
<li>
63-
<a href="#getting-started">Getting Started</a>
64-
<ul>
65-
<li><a href="#prerequisites">Prerequisites</a></li>
66-
<li><a href="#installation">Installation</a></li>
67-
</ul>
68-
</li>
69-
<li><a href="#usage">Usage</a></li>
70-
<li><a href="#roadmap">Roadmap</a></li>
71-
<li><a href="#contributing">Contributing</a></li>
72-
<li><a href="#license">License</a></li>
73-
<li><a href="#contact">Contact</a></li>
74-
<li><a href="#acknowledgements">Acknowledgements</a></li>
75-
</ol>
76-
</details>
77-
78-
79-
80-
<!-- ABOUT THE PROJECT -->
81-
## About The Project
82-
83-
[![Product Name Screen Shot][product-screenshot]](https://example.com)
84-
85-
There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.
86-
87-
Here's why:
88-
* Your time should be focused on creating something amazing. A project that solves a problem and helps others
89-
* You shouldn't be doing the same tasks over and over like creating a README from scratch
90-
* You should implement DRY principles to the rest of your life :smile:
91-
92-
Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!
93-
94-
A list of commonly used resources that I find helpful are listed in the acknowledgements.
95-
96-
### Built With
97-
98-
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
99-
* [Bootstrap](https://getbootstrap.com)
100-
* [JQuery](https://jquery.com)
101-
* [Laravel](https://laravel.com)
102-
103-
104-
105-
<!-- GETTING STARTED -->
106-
## Getting Started
107-
108-
This is an example of how you may give instructions on setting up your project locally.
109-
To get a local copy up and running follow these simple example steps.
110-
111-
### Prerequisites
112-
113-
This is an example of how to list things you need to use the software and how to install them.
114-
* npm
115-
```sh
116-
npm install npm@latest -g
117-
```
118-
119-
### Installation
120-
121-
1. Get a free API Key at [https://example.com](https://example.com)
122-
2. Clone the repo
123-
```sh
124-
git clone https://github.com/your_username_/Project-Name.git
125-
```
126-
3. Install NPM packages
127-
```sh
128-
npm install
129-
```
130-
4. Enter your API in `config.js`
131-
```JS
132-
const API_KEY = 'ENTER YOUR API';
133-
```
134-
135-
1+
# AES-CBC-128
1362

137-
<!-- USAGE EXAMPLES -->
138-
## Usage
1393

140-
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
4+
## Description
1415

142-
_For more examples, please refer to the [Documentation](https://example.com)_
6+
This project is a CBC moded AES-128 pure python module.
7+
It requires no dependencies at all an is implemented with native python3 only.
1438

9+
## Getting Started
14410

11+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
14512

146-
<!-- ROADMAP -->
147-
## Roadmap
148-
149-
See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a list of proposed features (and known issues).
150-
13+
### Prerequisites
15114

15+
The project is written in python3 only, hence it is the only prerequisite.
15216

153-
<!-- CONTRIBUTING -->
154-
## Contributing
17+
Run the following in order to verify your python version,
18+
the recommended version is `Python 3.9.7`
19+
```
20+
python --version
21+
```
15522

156-
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
23+
### Installing
15724

158-
1. Fork the Project
159-
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
160-
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
161-
4. Push to the Branch (`git push origin feature/AmazingFeature`)
162-
5. Open a Pull Request
25+
The only step, it to clone your local repository using
16326

27+
```
28+
git clone https://gitlab.com/orgurar/aes.git
29+
```
16430

31+
## Running
16532

166-
<!-- LICENSE -->
167-
## License
33+
You only have to run the main script with python3
16834

169-
Distributed under the MIT License. See `LICENSE` for more information.
35+
```
36+
python main.py
37+
```
17038

39+
### Tests
17140

41+
The `aes.py` module located in the `aes` source folder contains all the automated tests.
17242

173-
<!-- CONTACT -->
174-
## Contact
43+
Run those tests by running this module as the main module, use
17544

176-
Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com
45+
```
46+
cd aes/
17747
178-
Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
48+
python aes.py
49+
```
17950

51+
## Roadmap
18052

53+
In the future, I will add an implementations of another major AES modes of operations, such as OCB, CTR, etc.
18154

182-
<!-- ACKNOWLEDGEMENTS -->
183-
## Acknowledgements
184-
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
185-
* [Img Shields](https://shields.io)
186-
* [Choose an Open Source License](https://choosealicense.com)
187-
* [GitHub Pages](https://pages.github.com)
188-
* [Animate.css](https://daneden.github.io/animate.css)
189-
* [Loaders.css](https://connoratherton.com/loaders)
190-
* [Slick Carousel](https://kenwheeler.github.io/slick)
191-
* [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll)
192-
* [Sticky Kit](http://leafo.net/sticky-kit)
193-
* [JVectorMap](http://jvectormap.com)
194-
* [Font Awesome](https://fontawesome.com)
55+
## Authors and acknowledgment
19556

57+
- **Or Gur Arie** - Creator and Maintainer - [orgurar](https://gitlab.com/orgurar)
19658

59+
## License
19760

61+
Doraemon is licensed under the MIT license, see the [LICENSE](LICENSE) file for details.
19862

63+
## Acknowledgments
19964

200-
<!-- MARKDOWN LINKS & IMAGES -->
201-
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
202-
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
203-
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
204-
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
205-
[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
206-
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
207-
[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
208-
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
209-
[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
210-
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
211-
[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
212-
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
213-
[linkedin-url]: https://linkedin.com/in/othneildrew
214-
[product-screenshot]: images/screenshot.png
65+
* Hat tip to anyone whose code was used
66+
* Inspiration
67+
* etc

0 commit comments

Comments
 (0)