Skip to content

Commit 3ff6ed8

Browse files
committed
Update README.md for the first release
1 parent 315ca59 commit 3ff6ed8

3 files changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ Netmap stands for Network Mapper, a visualizer for your inventory of network dev
44

55
Built with love by Roopesh and friends in Go.
66

7+
## Getting Started
8+
9+
## Install using Go
10+
11+
```
12+
go install github.com/opennetworktools/netmap
13+
```
14+
715
## Usage
816

917
The graph can be created using the command `netmap create`,

cmd/version.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ var versionCmd = &cobra.Command{
1515
Short: "Print the version number of Netmap",
1616
Long: `All software has versions. This is Netmap's`,
1717
Run: func(cmd *cobra.Command, args []string) {
18-
fmt.Println("netmap v0.0.1 -- HEAD")
18+
fmt.Println("netmap v0.1.0 -- HEAD")
1919
},
2020
}

internal/visualizer/graphviz.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ func SaveTopologyWithGraphviz(ctx context.Context, networkMap *NetworkMap, times
4848
fmt.Println("Error creating node:", err)
4949
continue
5050
}
51-
node.SetLabel(utils.TruncateString(device, 3))
51+
node.SetLabel(utils.TruncateString(device, 10))
5252
node.SetShape(cgraph.EllipseShape)
5353
node.SetStyle(cgraph.FilledNodeStyle)
5454
nodes[device] = node
@@ -64,7 +64,7 @@ func SaveTopologyWithGraphviz(ctx context.Context, networkMap *NetworkMap, times
6464
fmt.Println("Error creating node:", err)
6565
continue
6666
}
67-
node.SetLabel(utils.TruncateString(neighbor, 3))
67+
node.SetLabel(utils.TruncateString(neighbor, 10))
6868
node.SetShape(cgraph.EllipseShape)
6969
node.SetStyle(cgraph.FilledNodeStyle)
7070
nodes[neighbor] = node

0 commit comments

Comments
 (0)