Skip to content

Commit 83375f4

Browse files
committed
Update README.md
1 parent 0d8cdf9 commit 83375f4

File tree

1 file changed

+5
-15
lines changed

1 file changed

+5
-15
lines changed

README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# API Tools
22

3-
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
3+
_A CLI to scrape some really useful UTD data, parse it, and upload it to the [Nebula API](https://github.com/utdnebula/nebula-api) for community use._
44

5-
_A CLI to scrape some really useful UTD data, parse it, and upload it to the Nebula API database for community use._
6-
7-
Part of [Project Nebula](https://about.utdnebula.com).
5+
Project maintained by [Nebula Labs](https://about.utdnebula.com).
86

97
## Design
108

@@ -22,6 +20,8 @@ Part of [Project Nebula](https://about.utdnebula.com).
2220

2321
## Contributing
2422

23+
Please visit our [Discord](https://discord.utdnebula.com) and talk to us if you'd like to contribute!
24+
2525
### Prerequisites
2626

2727
- Golang 1.23 (or higher)
@@ -34,14 +34,4 @@ To build the project, simply clone the repository and then either:
3434
- Run `make` in the root (top level) directory (for systems with `make` installed, i.e. most Linux distros, MacOS)
3535
- Run `build.bat` on Windows systems (unless you want to deal with getting `make` to work on Windows :P)
3636

37-
The build process will output an executable file named `api-tools`; this executable is the CLI and can be ran in your terminal!
38-
39-
### Deployment
40-
41-
[TBD]
42-
43-
## Questions or Feedback
44-
45-
If you have any questions about this project, reach out to the Project Nebula
46-
maintainers at [email protected] or open an issue or discussion on
47-
this repository.
37+
The build process will output an executable file named `api-tools`; this executable is the CLI and can be ran in your terminal!

0 commit comments

Comments
 (0)