Skip to content

Commit

Permalink
docs: update readme and create issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
amazingandyyy committed Apr 19, 2022
1 parent 7f04069 commit 047077e
Show file tree
Hide file tree
Showing 6 changed files with 88 additions and 6 deletions.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Bug Report
url: https://github.com/amazingandyyy/gofuzzyclone/issues/new
about: Thank you for using! Feel free report any bug you encounter.
- name: Feature request
url: https://github.com/amazingandyyy/gofuzzyclone/issues/new
about: Love to have a feature? Let me know!
- name: Follow author
url: https://github.com/amazingandyyy
about: Feel free to follow me!
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Report issue

## Background

- version:
- operating system:
- terminal(zsh/bash?):

## Description

- What do you expect to do?
- What does it really do?

## How to reproduce

## Extra notes
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# PR

## Related issue

fix: #1

## Features

- what does this add:
- testing/demo:

## Extra

- notes:
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ repos:
- id: shfmt
- id: script-must-have-extension
- id: markdownlint # Configure in .mdlrc
args: ["-r ~MD013,~MD033,~MD002"]
- repo: https://github.com/rhysd/actionlint
rev: v1.6.8
hooks:
Expand Down
52 changes: 46 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
# gofuzzyclone

<p styles="font-size: 20rem" align="center">
<img styles="margin: 0px" width="350px" src="https://i.giphy.com/media/NytMLKyiaIh6VH9SPm/giphy.webp" />
</p>
<h1 align="center">
gofuzzysearch
</h1>
<h4 align="center">
Go fuzzy search repos with regex or wildcard
</h4>
<p align="center">
Never clone repos one by one
</p>

## Installation

It's easy!

```sh
bash <(curl -sL https://raw.githubusercontent.com/amazingandyyy/gofuzzyclone/main/scripts/install.sh)
```
Expand All @@ -20,19 +31,48 @@ bash <(curl -sL https://raw.githubusercontent.com/amazingandyyy/gofuzzyclone/mai
# get instructions
gofuzzyclone -help
# fastline mode
# regex mode
gofuzzyclone -owner amazingandyyy -search ".*-deployments$" -output ./code
gofuzzyclone -owner amazingandyyy -search "*-template" -mode wildcard -output ./projects
# wildcard mode
gofuzzyclone -owner amazingandyyy -search "*-deployments" -mode wildcard -output ./projects
# interactive mode
gofuzzyclone
```

## Development

### Initialization

```sh
git clone https://github.com/amazingandyyy/gofuzzyclone.git
cd gofuzzyclone
./scripts/set
```

### Trigger pre-commit hook manually

```sh
pre-commit run --all-files
```

---

![banner](assets/repo-banner.jpg)

## Contribution

- Try out this tool
- Star this repo
- Share with your friend!
- [Create issue](https://github.com/amazingandyyy/gofuzzyclone/issues/new)
- Create PRs

## Resources

- [regex](http://regex101.com)
- [regex101](http://regex101.com)
- wildcard

## LICENSE

[MIT](./LICENSE)
[MIT](LICENSE)
Binary file added assets/repo-banner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 047077e

Please sign in to comment.