Skip to content

Commit 06245e3

Browse files
authored
docs: update README.md (#9)
1 parent 5aa630a commit 06245e3

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,43 @@
1-
[![tests](https://github.com/stasadev/ddev-python2/actions/workflows/tests.yml/badge.svg)](https://github.com/stasadev/ddev-python2/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2025.svg)
1+
[![add-on registry](https://img.shields.io/badge/DDEV-Add--on_Registry-blue)](https://addons.ddev.com)
2+
[![tests](https://github.com/stasadev/ddev-python2/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/stasadev/ddev-python2/actions/workflows/tests.yml?query=branch%3Amain)
3+
[![last commit](https://img.shields.io/github/last-commit/stasadev/ddev-python2)](https://github.com/stasadev/ddev-python2/commits)
4+
[![release](https://img.shields.io/github/v/release/stasadev/ddev-python2)](https://github.com/stasadev/ddev-python2/releases/latest)
25

3-
# DDEV Python2 Add-on <!-- omit in toc -->
6+
# DDEV Python 2
47

5-
* [What is ddev-python2?](#what-is-ddev-python2)
6-
* [Installation](#installation)
7-
* [Usage](#usage)
8+
## Overview
89

9-
## What is ddev-python2?
10+
[Python 2](https://www.python.org/doc/sunset-python-2/) has reached its end of life.
1011

11-
This repository allows you to install [legacy Python2](https://www.python.org/doc/sunset-python-2/) inside `ddev-webserver` in a DDEV project.
12+
This add-on integrates legacy Python 2 inside the `ddev-webserver` into your [DDEV](https://ddev.com/) project.
1213

13-
This is only required if your `npm` uses Python2 to build its dependencies.
14+
It is only needed if your `npm` setup requires Python 2 to build dependencies.
1415

1516
## Installation
1617

17-
For DDEV v1.23.5 or above run
18+
For DDEV v1.23.5 or above run:
1819

19-
```sh
20-
ddev add-on get stasadev/ddev-python2
21-
```
22-
23-
For earlier versions of DDEV run
24-
25-
```sh
26-
ddev get stasadev/ddev-python2
20+
```bash
21+
ddev add-on get ddev/ddev-python2
22+
ddev restart
2723
```
2824

29-
Then restart your project
25+
For earlier versions of DDEV run:
3026

31-
```sh
27+
```bash
28+
ddev get ddev/ddev-python2
3229
ddev restart
3330
```
3431

3532
## Usage
3633

37-
After installation, you can run Python2:
34+
After installation, you can run Python 2:
3835

3936
- `python2.7` (installed at `/usr/bin/python2.7`)
4037
- `python` (symlink to `python2.7` installed at `/usr/local/bin/python`)
4138

42-
This add-on also adds packages that are normally required for `npm` build, see [config.python2.yaml](./config.python2.yaml). Remove or replace the contents of this file if you only need Python2.
39+
This add-on also adds packages that are normally required for `npm` build, see [config.python2.yaml](./config.python2.yaml). Remove or replace the contents of this file if you only need Python 2.
40+
41+
## Credits
4342

4443
**Contributed and maintained by [@stasadev](https://github.com/stasadev)**

0 commit comments

Comments
 (0)