Merge pull request #17 from YunoHost/upgrade_readme
[enh] Update readme
This commit is contained in:
		
						commit
						d616f5ac06
					
				
							
								
								
									
										21
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										21
									
								
								README.md
									
									
									
									
									
								
							@ -1,11 +1,22 @@
 | 
				
			|||||||
# YunoHost example app
 | 
					# Example app for YunoHost
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- [Yunohost project](https://yunohost.org)
 | 
				
			||||||
 | 
					- [Exemple app website](https://example.com)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Description of the app.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Usage
 | 
					## Usage
 | 
				
			||||||
- Add application source files into `sources` subfolder.
 | 
					- Copy this app before work on it.
 | 
				
			||||||
- Edit `conf/nginx.conf` file to match application prerequisites.
 | 
					- Edit `conf/nginx.conf` file to match application prerequisites.
 | 
				
			||||||
- Edit manifest with application specific information.
 | 
					- Edit `manifest.json` with application specific information.
 | 
				
			||||||
- Edit the install, upgrade, remove, backup, restore scripts.
 | 
					- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
 | 
				
			||||||
- Add a LICENSE file for the package.
 | 
					- Add a `LICENSE` file for the package.
 | 
				
			||||||
 | 
					- Edit `README.md`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
**More information on the documentation page:**    
 | 
					**More information on the documentation page:**    
 | 
				
			||||||
https://yunohost.org/packaging_apps
 | 
					https://yunohost.org/packaging_apps
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Upgrade this package:**  
 | 
				
			||||||
 | 
					`sudo yunohost app upgrade --verbose example -u https://github.com/YunoHost-Apps/example_ynh`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Multi-user:** Yes/No. How about the ldap and HTTP auth support.
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
		Reference in New Issue
	
	Block a user