Skip to content

Commit

Permalink
Merge pull request #134 from MarketSquare/update_readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
leeuwe authored Jun 23, 2024
2 parents e1d86ae + a533829 commit 048788c
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![PyPi downloads](https://img.shields.io/pypi/dm/robotframework-mainframe3270.svg)](https://pypi.org/project/robotframework-mainframe3270/)
[![Total downloads](https://static.pepy.tech/personalized-badge/robotframework-mainframe3270?period=total&units=international_system&left_color=lightgrey&right_color=yellow&left_text=total)](https://pypi.org/project/robotframework-mainframe3270/)
[![Latest Version](https://img.shields.io/pypi/v/robotframework-mainframe3270.svg)](https://pypi.org/project/robotframework-mainframe3270/)
[![tests](https://github.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/actions/workflows/run-tests.yml/badge.svg?branch=master)](https://github.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/actions/workflows/run-tests.yml)
[![tests](https://github.com/MarketSquare/Robot-Framework-Mainframe-3270-Library/actions/workflows/run-tests.yml/badge.svg?branch=master)](https://github.com/MarketSquare/Robot-Framework-Mainframe-3270-Library/actions/workflows/run-tests.yml)
[![codecov](https://codecov.io/gh/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/branch/master/graph/badge.svg?token=N41G62D883)](https://codecov.io/gh/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library)

# Mainframe3270Library
Expand Down Expand Up @@ -44,7 +44,7 @@ or
brew install x3270
```

More information can be found on the [Wiki page](https://github.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/wiki/Installation) of this project.
More information can be found on the [Wiki page](https://github.com/MarketSquare/Robot-Framework-Mainframe-3270-Library/wiki/Instalation) of this project.

## Example
```RobotFramework
Expand All @@ -68,17 +68,17 @@ Example

## Keyword Documentation

You can find the keyword documentation [here](https://raw.githack.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/master/doc/Mainframe3270.html).
You can find the keyword documentation [here](https://raw.githack.com/MarketSquare/Robot-Framework-Mainframe-3270-Library/master/doc/Mainframe3270.html).

## Running with Docker

The Docker image contains everything that is needed to run Mainframe tests. Currently the image is not published to Docker Hub. In order to use it, perform the following steps.

1. Download the Dockerfile sources
```sh
curl -O https://raw.githubusercontent.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/master/Dockerfile
curl -O https://raw.githubusercontent.com/MarketSquare/Robot-Framework-Mainframe-3270-Library/master/Dockerfile

curl -O https://raw.githubusercontent.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/master/entrypoint.sh
curl -O https://raw.githubusercontent.com/MarketSquare/Robot-Framework-Mainframe-3270-Library/master/entrypoint.sh
```

2. Build the image:
Expand All @@ -93,13 +93,13 @@ docker run --user mfuser -v /path/to/your/tests:/home/mfuser/tests mainframe3270

## Contributing to Robot-Framework-Mainframe3270-Library

Interested in contributing to the project? Great to hear! Whether you found a bug, or want to develop a new feature, please refer to our [Contributing Guidelines](https://github.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/blob/master/CONTRIBUTING.md) to help you get started.
Interested in contributing to the project? Great to hear! Whether you found a bug, or want to develop a new feature, please refer to our [Contributing Guidelines](https://github.com/MarketSquare/Robot-Framework-Mainframe-3270-Library/blob/master/CONTRIBUTING.md) to help you get started.

## Wiki
For more information visit the repository [Wiki](https://github.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/wiki).
For more information visit the repository [Wiki](https://github.com/MarketSquare/Robot-Framework-Mainframe-3270-Library/wiki).

## Changelog
For an overview of the (latest) changes see [CHANGELOG](https://github.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/blob/master/CHANGELOG.md).
For an overview of the (latest) changes see [CHANGELOG](https://github.com/MarketSquare/Robot-Framework-Mainframe-3270-Library/blob/master/CHANGELOG.md).

## Authors
Initial development was sponsored by [Capgemini Engineering](https://www.capgemini.com/about-us/who-we-are/our-brands/capgemini-engineering/)
Expand All @@ -112,4 +112,4 @@ Initial development was sponsored by [Capgemini Engineering](https://www.capgemi
- **Robin Matz**

## License
This project is licensed under the MIT License - see [LICENSE](https://github.com/Altran-PT-GDC/Robot-Framework-Mainframe-3270-Library/blob/master/LICENSE.md) for details.
This project is licensed under the MIT License - see [LICENSE](https://github.com/MarketSquare/Robot-Framework-Mainframe-3270-Library/blob/master/LICENSE.md) for details.

0 comments on commit 048788c

Please sign in to comment.