diff --git a/README.md b/README.md index 11d4d88b607..43b456c5141 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,23 @@ -angr -==== +# angr [![Latest Release](https://img.shields.io/pypi/v/angr.svg)](https://pypi.python.org/pypi/angr/) +[![Python Version](https://img.shields.io/pypi/pyversions/angr)](https://pypi.python.org/pypi/angr/) [![PyPI Statistics](https://img.shields.io/pypi/dm/angr.svg)](https://pypistats.org/packages/angr) -[![Build Status](https://github.com/angr/angr/actions/workflows/.github/workflows/ci.yml/badge.svg)](https://github.com/angr/angr/actions/workflows/.github/workflows/ci.yml/badge.svg) [![License](https://img.shields.io/github/license/angr/angr.svg)](https://github.com/angr/angr/blob/master/LICENSE) -[![Gitbook](https://img.shields.io/badge/docs-gitbook-green.svg)](https://docs.angr.io) -[![API Docs](https://img.shields.io/badge/docs-api-green.svg)](https://angr.io/api-doc) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) angr is a platform-agnostic binary analysis framework. -It is brought to you by [the Computer Security Lab at UC Santa Barbara](https://seclab.cs.ucsb.edu), [SEFCOM at Arizona State University](https://sefcom.asu.edu), their associated CTF team, [Shellphish](https://shellphish.net), the open source community, and **[@rhelmot](https://github.com/rhelmot)**. +It is brought to you by [the Computer Security Lab at UC Santa Barbara](https://seclab.cs.ucsb.edu), [SEFCOM at Arizona State University](https://sefcom.asu.edu), their associated CTF team, [Shellphish](https://shellphish.net), the open source community, and **[@rhelmot](https://github.com/rhelmot)**. -# What? +## Project Links +Homepage: https://angr.io + +Project repository: https://github.com/angr/angr + +Documentation: https://docs.angr.io + +API Documentation: https://api.angr.io/en/latest/ + +## What is angr? angr is a suite of Python 3 libraries that let you load a binary and do a lot of cool things to it: @@ -29,7 +33,7 @@ The most common angr operation is loading a binary: `p = angr.Project('/bin/bash The short version of "how to install angr" is `mkvirtualenv --python=$(which python3) angr && python -m pip install angr`. -# Example +## Example angr does a lot of binary analysis stuff. To get you started, here's a simple example of using symbolic execution to get a flag in a CTF challenge.