Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Updated Installation Instructions #21

Merged
merged 1 commit into from
Jan 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions .github/workflows/notify.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
name: Starboy

on: [push, pull_request, issues, issue_comment, watch]
on:
push:
branches:
- master
pull_request:
types: [opened,closed]
issues:
types: [opened, closed, reopened]
issue_comment:
types: [created]
watch:
types: [started]

jobs:
build:
jobs:
build:
runs-on: ubuntu-latest

runs-on: ubuntu-latest

steps:
- name: Statusoli
steps:
- name: Statusoli
env:
TELEGRAM_CHAT_ID: ${{ secrets.chat}}
TELEGRAM_TOKEN: ${{secrets.token }}
Expand All @@ -24,4 +34,4 @@ jobs:
PR_TITLE: ${{ github.event.pull_request.title }}
PR_BODY: ${{ github.event.pull_request.body }}

run: sh -c "$(curl -sL https://raw.githubusercontent.com/athul/autom/master/tg_gh_action_noti.sh)"
run: sh -c "$(curl -sL https://raw.githubusercontent.com/athul/autom/master/tg_gh_action_noti.sh)"
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,35 +12,27 @@ Shelby is a fast ⚡️ ,lightweight 🎈 ,minimal✨, shell prompt written in P

-------
## Installation
Initially the Packaging is so dull and I'm really new to this stuff. Follow the steps below,
Follow the steps below, and **Post Installation Instructions**
- Run
```bash
$ sh -c "$(curl -sL https://git.io/ishelby)"
```
----
OR
- Download the binary from the [Releases](https://github.com/athul/shelby/releases) page
- Download the binary from the [WorkFlow Artifacts](https://github.com/athul/shelby/actions?query=workflow%3A%22Go+Build%22).
- You might wanto to make the binary executable, run `chmod 775 <binary_name>`
- Move the Binary to `/usr/local/bin/`
- Enjoy :tada:

OR
Build From Source

- Clone the Repo
- Run `go get -v`
- Run `go build`
- Move the Binary to `/usr/local/bin/`
- Move the Binary to `~/.local/bin/shelby`

### Extra Bits
- `[+]` shows if you've got Untracked Files
- `[2+]` shows if you've got 2 untracked files
- `[!]` shows if you've got Unstaged Files
- `[3!]` shows if you've got 3 unstaged files
- Dispalys any VirtualENVs you're working in
- Displays the Current Git Branch
- Displays **Username** and **Hostname** of the machine while in SSH
- Small Size(~=2MB)
## Post Installation Instructions

## Usage
> You must have to add the below code to either the Bashrc or Zshrc file inorder to Shelby to fully work.

The following usage examples are just one example of how Shelby can be
configured. The examples below will result in a setup similar to the one shown
Expand Down Expand Up @@ -77,6 +69,18 @@ prompt_symbol='❯'
PROMPT="%(?.%F{green}.%F{red})${prompt_symbol}%f "
```


### Extra Bits
- `[+]` shows if you've got Untracked Files
- `[2+]` shows if you've got 2 untracked files
- `[!]` shows if you've got Unstaged Files
- `[3!]` shows if you've got 3 unstaged files
- Dispalys any VirtualENVs you're working in
- Displays the Current Git Branch
- Displays **Username** and **Hostname** of the machine while in SSH
- Small Size(~=2MB)


### Inspired From
- [StarShip by @matchai](https://starship.rs)
- [SpaceShip by @denysdovhan](https://github.com/denysdovhan/spaceship-prompt)
Expand Down