Add license and more documentation
This commit is contained in:
		
							parent
							
								
									9ab2b6a9f2
								
							
						
					
					
						commit
						2935dc0658
					
				| 
						 | 
					@ -0,0 +1,24 @@
 | 
				
			||||||
 | 
					This is free and unencumbered software released into the public domain.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Anyone is free to copy, modify, publish, use, compile, sell, or
 | 
				
			||||||
 | 
					distribute this software, either in source code form or as a compiled
 | 
				
			||||||
 | 
					binary, for any purpose, commercial or non-commercial, and by any
 | 
				
			||||||
 | 
					means.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					In jurisdictions that recognize copyright laws, the author or authors
 | 
				
			||||||
 | 
					of this software dedicate any and all copyright interest in the
 | 
				
			||||||
 | 
					software to the public domain. We make this dedication for the benefit
 | 
				
			||||||
 | 
					of the public at large and to the detriment of our heirs and
 | 
				
			||||||
 | 
					successors. We intend this dedication to be an overt act of
 | 
				
			||||||
 | 
					relinquishment in perpetuity of all present and future rights to this
 | 
				
			||||||
 | 
					software under copyright law.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 | 
				
			||||||
 | 
					EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 | 
				
			||||||
 | 
					MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 | 
				
			||||||
 | 
					IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 | 
				
			||||||
 | 
					OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 | 
				
			||||||
 | 
					ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 | 
				
			||||||
 | 
					OTHER DEALINGS IN THE SOFTWARE.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					For more information, please refer to <http://unlicense.org/>
 | 
				
			||||||
							
								
								
									
										10
									
								
								Readme.md
								
								
								
								
							
							
						
						
									
										10
									
								
								Readme.md
								
								
								
								
							| 
						 | 
					@ -1,3 +1,13 @@
 | 
				
			||||||
## URL parameters
 | 
					## URL parameters
 | 
				
			||||||
You can set the room for the section 'Next up here' by specifying either the (frab-XML) room name or room-guid.
 | 
					You can set the room for the section 'Next up here' by specifying either the (frab-XML) room name or room-guid.
 | 
				
			||||||
E.g. https://hacc.4future.dev/html-infobeamer/?room=60dd7f55-9f88-4de6-ad98-b9c4e2810300 or https://hacc.4future.dev/html-infobeamer/?room=hacc%20M%C3%BCnchen%20/%20about:future%20-%20M%C3%BCnchen
 | 
					E.g. https://hacc.4future.dev/html-infobeamer/?room=60dd7f55-9f88-4de6-ad98-b9c4e2810300 or https://hacc.4future.dev/html-infobeamer/?room=hacc%20M%C3%BCnchen%20/%20about:future%20-%20M%C3%BCnchen
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## API
 | 
				
			||||||
 | 
					This repo pulls the external data from `api.oct.re` (Server hosted by octycs)
 | 
				
			||||||
 | 
					You can host everything yourself in case you have a Twitter API key.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					`api.oct.re/tweets-rc3.json` -> `dl_tweets.sh`
 | 
				
			||||||
 | 
					`api.oct.re/fahrplan.json` -> `fahrplan.py`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## License
 | 
				
			||||||
 | 
					All parts of this software except the `fahrplan.py` downloader are licensed under the _Unlicense_ (see `License.md`)
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -0,0 +1,4 @@
 | 
				
			||||||
 | 
					#!/bin/bash
 | 
				
			||||||
 | 
					export BEARER_TOKEN=<Enter your Bearer Token here>
 | 
				
			||||||
 | 
					curl -s -X GET -H "Authorization: Bearer $BEARER_TOKEN" \
 | 
				
			||||||
 | 
						    "https://api.twitter.com/2/tweets/search/recent?query=%23rC3&tweet.fields=created_at&expansions=author_id,attachments.media_keys&media.fields=preview_image_url&user.fields=profile_image_url" > tweets-rc3.json
 | 
				
			||||||
		Loading…
	
		Reference in New Issue