publish pure on npm

This commit is contained in:
Sindre Sorhus
2014-03-30 20:39:57 +02:00
parent 0ce7d9b371
commit ac870ff6ff
2 changed files with 44 additions and 9 deletions

30
package.json Normal file
View File

@@ -0,0 +1,30 @@
{
"name": "pure-prompt",
"version": "0.1.0",
"description": "Pretty, minimal and fast ZSH prompt",
"license": "MIT",
"repository": "sindresorhus/pure",
"author": {
"name": "Sindre Sorhus",
"email": "sindresorhus@gmail.com",
"url": "http://sindresorhus.com"
},
"engines": {
"node": ">=0.10.0"
},
"scripts": {
"postinstall": "ln -sf \"$PWD/pure.zsh\" /usr/local/share/zsh/site-functions/prompt_pure_setup || Could not automagically symlink the prompt. Check out the readme on how to do it manually: https://github.com/sindresorhus/pure#manually"
},
"files": [
"pure.zsh"
],
"keywords": [
"zsh",
"sh",
"shell",
"bash",
"pure",
"prompt",
"theme"
]
}

View File

@@ -20,13 +20,21 @@ Most prompts are cluttered, ugly and slow. I wanted something visually pleasing
- Can easily be used as a starting point for your own custom prompt. - Can easily be used as a starting point for your own custom prompt.
## Getting started ## Install
### npm
```sh
$ npm install --global pure-prompt
```
### Manually
- Clone this repo, add it as a submodule, or just download `pure.zsh`. - Clone this repo, add it as a submodule, or just download `pure.zsh`.
- Symlink `pure.zsh` to somewhere in [`$fpath`](http://www.refining-linux.org/archives/46/ZSH-Gem-12-Autoloading-functions/) with the name `prompt_pure_setup`. - Symlink `pure.zsh` to somewhere in [`$fpath`](http://www.refining-linux.org/archives/46/ZSH-Gem-12-Autoloading-functions/) with the name `prompt_pure_setup`.
Example: #### Example
```sh ```sh
$ ln -s "$PWD/pure.zsh" /usr/local/share/zsh/site-functions/prompt_pure_setup $ ln -s "$PWD/pure.zsh" /usr/local/share/zsh/site-functions/prompt_pure_setup
@@ -46,17 +54,14 @@ Then install the theme there:
$ ln -s "$PWD/pure.zsh" "$HOME/.zfunctions/prompt_pure_setup" $ ln -s "$PWD/pure.zsh" "$HOME/.zfunctions/prompt_pure_setup"
``` ```
- Initialize the prompt system (if not so already):
## Getting started
Initialize the prompt system (if not so already) and choose `pure`:
```sh ```sh
# .zshrc # .zshrc
autoload -U promptinit && promptinit autoload -U promptinit && promptinit
```
- Choose this prompt:
```sh
# .zshrc
prompt pure prompt pure
``` ```