traverse

README

Traverse

Traverse any git repo with go!

🚀 Getting Started\

Description

In short this packages make it so that users can grab teh contents of github repo and

Installation

Package can be downloaded by using go

go get github.com/NinjaAung/traverse

Usage

There are three main function that traverse has:

Scraping.Run(repoName)

Scraping.Run() is of course resposible of returning a repo struct resposible with data: Name, Route, File and Dir used like this:

repo, _ := Scraping.Run("NinjaAung/Traverse")

*repo.SaveToJSON(filePath)

SaveToJSON takes a repo struct and marshall it's data in a list of repo in json, used like this:

repo.SaveToJSON("example.json")

tra(filePath)

tra, short for traverse take filePath to the json info and reads the first item or any if desire and allows the user to traverse through it in the terminal

tra("example.json")

Misc

Here is a collection of traverse related items:

• General landscaping / future plans with Traverse
• Google Slides and Recording