Skip to content

Commit

Permalink
README, travis.
Browse files Browse the repository at this point in the history
  • Loading branch information
hanjoes committed Jun 15, 2019
1 parent dfc8bee commit 2f1c8e8
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 3 deletions.
12 changes: 12 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
os:
- linux
- osx
language: generic
sudo: required
dist: trusty
env: SWIFT_VERSION=5.0.1
osx_image: xcode10.2
install:
- eval "$(curl -sL https://swiftenv.fuller.li/install.sh)"
script:
- swift build
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,29 @@
# SwiftPrompt
[![Build Status](https://travis-ci.org/hanjoes/swift-prompt.svg?branch=master)](https://travis-ci.org/hanjoes/swift-prompt)

Prompt script built using Swift.
# Swift Prompt

Prompt command executor built using Swift.

# Features

## Information Rich
It provides below information:
* user login
* host ip address
* git status

## Non-blocking
The "swift_prompt_nanny" is a daemon meant for synchronizing your repository with remote. It kicks in every set amount of seconds (currently hard-coded 10s). Press "ENTER" to continue if you see a question mark blinking (shown in the demo below).

# Usage

Add the following line to your shell application's resource file:

```bash
PROMPT_COMMAND='PS1="`/path/to/SwiftPrompt`"'
PROMPT_COMMAND="/path/to/swift_prompt" # make sure nanny is in the same folder
PS1 = "> " # or your favourate prompt script.
```

# Demo

![Quick Demo](./swift_prompt_demo.gif)
Binary file added swift_prompt_demo.gif
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 2f1c8e8

Please sign in to comment.