Blame view

node_modules/bower/README.md 5 KB
2dda2e10   Administrator   generator ignore
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
  # Bower - A package manager for the web
  
  > Bower needs resources for its maintenance. Please fill [this form](https://docs.google.com/forms/d/1i-Opb-uPdqUBBZQSbngv3Y3bfolG1gbBvtRLfxMnzRE/viewform?c=0&w=1) if you think you can help.
  
  [![Build Status](https://travis-ci.org/bower/bower.svg?branch=master)](https://travis-ci.org/bower/bower)
  [![Windows Build](https://ci.appveyor.com/api/projects/status/jr6vfra8w84plh2g/branch/master?svg=true)](https://ci.appveyor.com/project/sheerun/bower/history)
  [![Coverage Status](https://img.shields.io/coveralls/bower/bower.svg)](https://coveralls.io/r/bower/bower?branch=master)
  [![Discord chat](https://img.shields.io/badge/discord-join%20chat%20%E2%86%92-brightgreen.svg?style=flat)](https://discord.gg/0fFM7QF0KpZRh2cY)
  [![Issue Stats](http://issuestats.com/github/bower/bower/badge/pr?style=flat)](http://issuestats.com/github/bower/bower)
  [![Issue Stats](http://issuestats.com/github/bower/bower/badge/issue?style=flat)](http://issuestats.com/github/bower/bower)
  
  <img align="right" height="300" src="http://bower.io/img/bower-logo.png">
  
  ---
  
  Bower offers a generic, unopinionated solution to the problem of **front-end package management**, while exposing the package dependency model via an API that can be consumed by a more opinionated build stack. There are no system wide dependencies, no dependencies are shared between different apps, and the dependency tree is flat.
  
  Bower runs over Git, and is package-agnostic. A packaged component can be made up of any type of asset, and use any type of transport (e.g., AMD, CommonJS, etc.).
  
  **View complete docs on [bower.io](http://bower.io)**
  
  [View all packages available through Bower's registry](http://bower.io/search/).
  
  ## Install
  
  ```sh
  $ npm install -g bower
  ```
  
  Bower depends on [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/). Also make sure that [git](http://git-scm.com/) is installed as some bower
  packages require it to be fetched and installed.
  
  
  ## Usage
  
  See complete command line reference at [bower.io/docs/api/](http://bower.io/docs/api/)
  
  ### Installing packages and dependencies
  
  ```sh
  # install dependencies listed in bower.json
  $ bower install
  
  # install a package and add it to bower.json
  $ bower install <package> --save
  
  # install specific version of a package and add it to bower.json
  $ bower install <package>#<version> --save
  ```
  
  ### Using packages
  
  We discourage using bower components statically for performance and security reasons (if component has an `upload.php` file that is not ignored, that can be easily exploited to do malicious stuff).
  
  The best approach is to process components installed by bower with build tool (like [Grunt](http://gruntjs.com/) or [gulp](http://gulpjs.com/)), and serve them concatenated or using a module loader (like [RequireJS](http://requirejs.org/)).
  
  ### Uninstalling packages
  
  To uninstall a locally installed package:
  
  ```sh
  $ bower uninstall <package-name>
  ```
  
  ### prezto and oh-my-zsh users
  
  On `prezto` or `oh-my-zsh`, do not forget to `alias bower='noglob bower'` or `bower install jquery\#1.9.1`
  
  ### Never run Bower with sudo
  
  Bower is a user command; there is no need to execute it with superuser permissions.
  
  ### Windows users
  
  To use Bower on Windows, you must install
  [Git for Windows](http://git-for-windows.github.io/) correctly. Be sure to check the
  options shown below:
  
  <img src="https://cloud.githubusercontent.com/assets/10702007/10532690/d2e8991a-7386-11e5-9a57-613c7f92e84e.png" width="534" height="418" alt="Git for Windows" />
  
  <img src="https://cloud.githubusercontent.com/assets/10702007/10532694/dbe8857a-7386-11e5-9bd0-367e97644403.png" width="534" height="418" alt="Git for Windows" />
  
  Note that if you use TortoiseGit and if Bower keeps asking for your SSH
  password, you should add the following environment variable: `GIT_SSH -
  C:\Program Files\TortoiseGit\bin\TortoisePlink.exe`. Adjust the `TortoisePlink`
  path if needed.
  
  ### Ubuntu users
  
  To use Bower on Ubuntu, you might need to link `nodejs` executable to `node`:
  
  ```
  sudo ln -s /usr/bin/nodejs /usr/bin/node
  ```
  
  ## Configuration
  
  Bower can be configured using JSON in a `.bowerrc` file. Read over available options at [bower.io/docs/config](http://bower.io/docs/config).
  
  
  ## Support
  
  * [Discord chat](https://discord.gg/0fFM7QF0KpZRh2cY)
  * [StackOverflow](http://stackoverflow.com/questions/tagged/bower)
  * [Mailinglist](http://groups.google.com/group/twitter-bower) - twitter-bower@googlegroups.com
  
  ## Contributing
  
  We welcome [contributions](https://github.com/bower/bower/graphs/contributors) of all kinds from anyone. Please take a moment to review the [guidelines for contributing](CONTRIBUTING.md).
  
  * [Bug reports](https://github.com/bower/bower/wiki/Report-a-Bug)
  * [Feature requests](CONTRIBUTING.md#features)
  * [Pull requests](CONTRIBUTING.md#pull-requests)
  
  
  Note that on Windows for tests to pass you need to configure Git before cloning:
  
  ```
  git config --global core.autocrlf input
  ```
  
  ## License
  
  Copyright (c) 2016 Twitter and [other contributors](https://github.com/bower/bower/graphs/contributors)
  
  Licensed under the MIT License