Skip to content

Commit f6ae9c5

Browse files
authored
Readme adjustments (#55)
1 parent 1c918af commit f6ae9c5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Graphed Excel
1+
# Graphedexcel
22

33
[![current release version](https://img.shields.io/github/release/dalager/graphedexcel.svg?style=flat-square)](https://github.com/dalager/graphedexcel/releases)
44
[![pypi version](https://img.shields.io/pypi/v/graphedexcel.svg?style=flat-square)](https://pypi.python.org/pypi/graphedexcel)
@@ -8,19 +8,19 @@
88

99
<img src="docs/images/Book1.xlsx.png" align="right" width="300" alt="Plot from Example Book1.xlsx file">
1010

11-
Tool to analyze and visualize dependencies between cells in Excel spreadsheets in order to get an understanding of the complexity.
11+
## Overview
1212

13-
Will generate a graph of the dependencies between cells in an Excel spreadsheet. Data extracted with `openpyxl` (<https://foss.heptapod.net/openpyxl/openpyxl>), the graph is generated with the `networkx` library (<https://networkx.org/>) and is visualized using `matplotlib`.
13+
Graphedexcel takes an Excel file and creates a graph data structure with a visual representation.
1414

1515
<br clear="right"/>
1616

1717
## Usage
1818

1919
GraphedExcel can be used in three ways:
2020

21-
1. As python CLI tool, installed from PyPi with `pip install graphedexcel`
22-
2. As a Docker container, `ghcr.io/dalager/graphedexcel`, exposing the CLI tool, not requiring any python dependencies being installed.
23-
3. As a Python module used within your own code, by importing the `graphedexcel` module.
21+
1. As a Python CLI tool, installed from PyPi with `pip install graphedexcel` (requires Python)
22+
2. As a Docker container, `ghcr.io/dalager/graphedexcel`, exposing the CLI tool, not requiring any python dependencies being installed. (Requires Docker)
23+
3. As a Python module used within your own code, by importing the `graphedexcel` module. (Requires Python and some python programming experience)
2424

2525
### CLI Tool
2626

0 commit comments

Comments
 (0)