Skip to content

Commit c5f9076

Browse files
committed
improve docs
1 parent 57eb390 commit c5f9076

File tree

1 file changed

+56
-8
lines changed

1 file changed

+56
-8
lines changed

README.md

Lines changed: 56 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,29 +33,77 @@ A very smart filemanager to manage your files in the browser developed in Angula
3333
### Backend API
3434
[Read the docs](API.md)
3535

36+
---------
37+
3638
### Use in your existing project
3739
**1) Install and use**
3840
```bower install --save angular-filemanager```
3941

4042
**2) Include the dependencies in your project**
4143
```html
4244
<!-- third party -->
43-
<script src="bower_components/angular/angular.min.js"></script>
44-
<script src="bower_components/angular-translate/angular-translate.min.js"></script>
45-
<script src="bower_components/angular-cookies/angular-cookies.min.js"></script>
46-
<script src="bower_components/jquery/dist/jquery.min.js"></script>
47-
<script src="bower_components/bootstrap/dist/js/bootstrap.min.js"></script>
48-
<link rel="stylesheet" href="bower_components/bootswatch/paper/bootstrap.min.css" />
45+
<script src="bower_components/angular/angular.min.js"></script>
46+
<script src="bower_components/angular-translate/angular-translate.min.js"></script>
47+
<script src="bower_components/angular-cookies/angular-cookies.min.js"></script>
48+
<script src="bower_components/jquery/dist/jquery.min.js"></script>
49+
<script src="bower_components/bootstrap/dist/js/bootstrap.min.js"></script>
50+
<link rel="stylesheet" href="bower_components/bootswatch/paper/bootstrap.min.css" />
51+
4952
<!-- angular-filemanager -->
50-
<script src="dist/angular-filemanager.min.js"></script>
51-
<link rel="stylesheet" href="dist/angular-filemanager.css">
53+
<link rel="stylesheet" href="dist/angular-filemanager.css">
54+
<script src="dist/angular-filemanager.min.js"></script>
5255
```
5356

5457
**3) Use the angular directive in your HTML**
5558
```html
5659
<angular-filemanager></angular-filemanager>
5760
```
5861

62+
---------
63+
64+
### Using source files instead of minified js
65+
```html
66+
<!-- Uncomment if you need to use raw source code
67+
<script src="src/js/app.js"></script>
68+
<script src="src/js/config.js"></script>
69+
<script src="src/js/chmod.js"></script>
70+
<script src="src/js/item.js"></script>
71+
<script src="src/js/filenavigator.js"></script>
72+
<script src="src/js/fileuploader.js"></script>
73+
<script src="src/js/translations.js"></script>
74+
<script src="src/js/controller.js"></script>
75+
<script src="src/js/selector-controller.js"></script>
76+
<link rel="stylesheet" href="src/css/angular-filemanager.css">
77+
-->
78+
79+
<!-- Comment if you need to use raw source code -->
80+
<link rel="stylesheet" href="dist/angular-filemanager.css">
81+
<script src="dist/angular-filemanager.min.js"></script>
82+
<!-- /Comment if you need to use raw source code -->
83+
```
84+
85+
---------
86+
87+
### Extending the configuration file
88+
```html
89+
<script type="text/javascript">
90+
//example to override angular-filemanager default config
91+
angular.module('FileManagerApp').config(['fileManagerConfigProvider', function (fileManagerConfig) {
92+
var defaults = fileManagerConfig.$get();
93+
fileManagerConfig.set({
94+
appName: 'Demo - github.com/joni2back/angular-filemanager',
95+
sidebar: false,
96+
allowedActions: angular.extend(defaults.allowedActions, {
97+
remove: true
98+
copy: false
99+
})
100+
});
101+
}]);
102+
</script>
103+
```
104+
105+
---------
106+
59107
### Contribute
60108
To contribute to the project you can simply fork this repo. To build a minified version, you can simply run the Gulp
61109
task `gulp build`. The minified/uglified files are created in the `dist` folder.

0 commit comments

Comments
 (0)