Skip to content
This repository was archived by the owner on Feb 16, 2024. It is now read-only.

Commit 920b503

Browse files
committed
Updated badges for master and improved README formatting
1 parent 465c46f commit 920b503

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

README.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,33 @@
11
# SUPER Android Analyzer #
22

3-
[![Build Status](https://travis-ci.org/SUPERAndroidAnalyzer/super.svg?branch=develop)](https://travis-ci.org/SUPERAndroidAnalyzer/super)
4-
[![Build status](https://ci.appveyor.com/api/projects/status/7xuikqyne4a2jn7e?svg=true)](https://ci.appveyor.com/project/Razican/super)
5-
[![Coverage Status](https://coveralls.io/repos/github/SUPERAndroidAnalyzer/super/badge.svg?branch=develop)](https://coveralls.io/github/SUPERAndroidAnalyzer/super?branch=develop)
3+
[![Build Status](https://travis-ci.org/SUPERAndroidAnalyzer/super.svg?branch=master)](https://travis-ci.org/SUPERAndroidAnalyzer/super)
4+
[![Build status](https://ci.appveyor.com/api/projects/status/7xuikqyne4a2jn7e/branch/master?svg=true)](https://ci.appveyor.com/project/Razican/super/branch/master)
5+
[![Coverage Status](https://coveralls.io/repos/github/SUPERAndroidAnalyzer/super/badge.svg?branch=master)](https://coveralls.io/github/SUPERAndroidAnalyzer/super?branch=master)
66

77
<img src="src/super.jpg" alt="SUPER Android Analyzer logo" title="SUPER Android Analyzer" width="150">
88

99
Secure, Unified, Powerful and Extensible Rust Android Analyzer
1010

11-
This project aims to create an automatic system capable of analyzing **Android** applications to search for security vulnerabilities. In the process of creating such tool the current market will be analyzed to look into the existent solutions and find out what can be improved. Also, a vulnerability analysis process will be researched, choosing the one that best matches with the original objectives to design our tool later.
11+
This project aims to create an automatic system capable of analyzing **Android** applications to
12+
search for security vulnerabilities. In the process of creating such tool the current market will
13+
be analyzed to look into the existent solutions and find out what can be improved. Also, a
14+
vulnerability analysis process will be researched, choosing the one that best matches with the
15+
original objectives to design our tool later.
1216

13-
The second objective of the project will be to implement the developed tool in a way that it will be capable of analyzing a significant amount of applications. During this process new knowledge will be acquired both in technology and security, with will provide us with the bases for new developments.
17+
The second objective of the project will be to implement the developed tool in a way that it will
18+
be capable of analyzing a significant amount of applications. During this process new knowledge
19+
will be acquired both in technology and security, with will provide us with the bases for new
20+
developments.
1421

15-
The main objective of the project will be to analyze a big amount of **Android** applications from the **Google Play** market carrying out a global analysis of the current state of the security in **Android** applications. Furthermore, our applications could be used in the future to make an analysis of the evolution of said state.
22+
The main objective of the project will be to analyze a big amount of **Android** applications from
23+
the **Google Play** market carrying out a global analysis of the current state of the security in
24+
**Android** applications. Furthermore, our applications could be used in the future to make an
25+
analysis of the evolution of said state.
1626

1727
## Installation ##
1828

19-
We are planning on releasing binaries for the application so it is easier to use. Until then, installing **Rust** is needed to use it. These are the steps before using the program:
29+
We are planning on releasing binaries for the application so it is easier to use. Until then,
30+
installing **Rust** is needed to use it. These are the steps before using the program:
2031

2132
1. Download and install **Rust**. This is easily done through the following link:
2233

@@ -26,7 +37,8 @@ We are planning on releasing binaries for the application so it is easier to use
2637

2738
`git clone https://github.com/SUPERAndroidAnalyzer/super.git`
2839

29-
3. Build dependencies. Inside the repository, execute the following command. It should download and compile all program dependencies.
40+
3. Build dependencies. Inside the repository, execute the following command. It should download and
41+
compile all program dependencies.
3042

3143
`cargo build`
3244

@@ -36,7 +48,10 @@ If everything went right up until this point, you're ready to go!
3648

3749
## Usage ##
3850

39-
SUPER is very easy to use. Just download the desired *.apk* into the *downloads* folder (create that folder if necessary) and use the name as an argument when running the program. After the execution, a detailed report will appear in the *results* folder with that application name. There are a few usage options available:
51+
SUPER is very easy to use. Just download the desired *.apk* into the *downloads* folder (create
52+
that folder if necessary) and use the name as an argument when running the program. After the
53+
execution, a detailed report will appear in the *results* folder with that application name. There
54+
are a few usage options available:
4055

4156
```
4257
USAGE:
@@ -61,4 +76,6 @@ for instructions about how to proceed.
6176

6277
## License ##
6378

64-
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
79+
This program is free software: you can redistribute it and/or modify it under the terms of the GNU
80+
General Public License as published by the Free Software Foundation, either version 3 of the
81+
License, or (at your option) any later version.

0 commit comments

Comments
 (0)