Initial commit of README.md.
Signed-off-by: Abdulkadir Furkan Şanlı <me@abdulocra.cy>
This commit is contained in:
		
							
								
								
									
										24
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										24
									
								
								README.md
									
									
									
									
									
								
							@@ -1,2 +1,24 @@
 | 
				
			|||||||
# darkirc-container
 | 
					# DarkIRC Container
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This repository houses an OCI/Docker container image for DarkIRC.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					DarkIRC is the main mode of communication for the [DarkFi](https://dark.fi) project.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Usage
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Run it with Docker:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```shell
 | 
				
			||||||
 | 
					docker run -d --name darkirc -p 6667:6667 git.abdulocra.cy/abdulocracy/darkirc:latest
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Or run it with Docker Compose:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```yaml
 | 
				
			||||||
 | 
					services:
 | 
				
			||||||
 | 
					  darkirc:
 | 
				
			||||||
 | 
					    container_name: darkirc
 | 
				
			||||||
 | 
					    image: git.abdulocra.cy/abdulocracy/darkirc:latest
 | 
				
			||||||
 | 
					    ports:
 | 
				
			||||||
 | 
					      - "6667:6667"
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user