Replace placeholder README
This commit is contained in:
		
							parent
							
								
									f365c4ac19
								
							
						
					
					
						commit
						8ae1b04ad6
					
				@ -1,56 +1,21 @@
 | 
			
		||||
# ipfs Cookbook
 | 
			
		||||
 | 
			
		||||
TODO: Enter the cookbook description here.
 | 
			
		||||
 | 
			
		||||
e.g.
 | 
			
		||||
This cookbook makes your favorite breakfast sandwich.
 | 
			
		||||
This cookbook installs ipfs and starts it as a daemon
 | 
			
		||||
 | 
			
		||||
## Requirements
 | 
			
		||||
 | 
			
		||||
TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
 | 
			
		||||
 | 
			
		||||
e.g.
 | 
			
		||||
### Platforms
 | 
			
		||||
 | 
			
		||||
- SandwichOS
 | 
			
		||||
This cookbook is tested on Ubuntu 16.06, 14.04 and Debian 8 using Test Kitchen
 | 
			
		||||
 | 
			
		||||
### Chef
 | 
			
		||||
 | 
			
		||||
- Chef 12.0 or later
 | 
			
		||||
 | 
			
		||||
### Cookbooks
 | 
			
		||||
 | 
			
		||||
- `toaster` - ipfs needs toaster to brown your bagel.
 | 
			
		||||
 | 
			
		||||
## Attributes
 | 
			
		||||
 | 
			
		||||
TODO: List your cookbook attributes here.
 | 
			
		||||
 | 
			
		||||
e.g.
 | 
			
		||||
### ipfs::default
 | 
			
		||||
 | 
			
		||||
<table>
 | 
			
		||||
  <tr>
 | 
			
		||||
    <th>Key</th>
 | 
			
		||||
    <th>Type</th>
 | 
			
		||||
    <th>Description</th>
 | 
			
		||||
    <th>Default</th>
 | 
			
		||||
  </tr>
 | 
			
		||||
  <tr>
 | 
			
		||||
    <td><tt>['ipfs']['bacon']</tt></td>
 | 
			
		||||
    <td>Boolean</td>
 | 
			
		||||
    <td>whether to include bacon</td>
 | 
			
		||||
    <td><tt>true</tt></td>
 | 
			
		||||
  </tr>
 | 
			
		||||
</table>
 | 
			
		||||
 | 
			
		||||
## Usage
 | 
			
		||||
 | 
			
		||||
### ipfs::default
 | 
			
		||||
 | 
			
		||||
TODO: Write usage instructions for each cookbook.
 | 
			
		||||
 | 
			
		||||
e.g.
 | 
			
		||||
Just include `ipfs` in your node's `run_list`:
 | 
			
		||||
 | 
			
		||||
```json
 | 
			
		||||
@ -62,19 +27,7 @@ Just include `ipfs` in your node's `run_list`:
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Contributing
 | 
			
		||||
 | 
			
		||||
TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
 | 
			
		||||
 | 
			
		||||
e.g.
 | 
			
		||||
1. Fork the repository on Github
 | 
			
		||||
2. Create a named feature branch (like `add_component_x`)
 | 
			
		||||
3. Write your change
 | 
			
		||||
4. Write tests for your change (if applicable)
 | 
			
		||||
5. Run the tests, ensuring they all pass
 | 
			
		||||
6. Submit a Pull Request using Github
 | 
			
		||||
 | 
			
		||||
## License and Authors
 | 
			
		||||
 | 
			
		||||
Authors: TODO: List authors
 | 
			
		||||
Authors: Greg Karékinian
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user