modernizing README.md

README.md

@@ -1,5 +1,6 @@
 # Adafruit BME280 Library [![Build Status](https://github.com/adafruit/Adafruit_BME280_Library/workflows/Arduino%20Library%20CI/badge.svg)](https://github.com/adafruit/Adafruit_BME280_Library/actions)[![Documentation](https://github.com/adafruit/ci-arduino/blob/master/assets/doxygen_badge.svg)](http://adafruit.github.io/Adafruit_BME280_Library/html/index.html)
 
+
 <a href="http://www.adafruit.com/products/2652"><img src="./assets/board.jpg" width="500"/></a>
 
 This is a library for the Adafruit BME280 Humidity, Barometric Pressure + Temp sensor
@@ -7,25 +8,47 @@ This is a library for the Adafruit BME280 Humidity, Barometric Pressure + Temp s
 Designed specifically to work with the Adafruit BME280 Breakout 
  * http://www.adafruit.com/products/2652
 
-These sensors use I2C or SPI to communicate, up to 4 pins are required to interface
+Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!
 
-Use of this library also requires [Adafruit_Sensor](https://github.com/adafruit/Adafruit_Sensor)
+# Installation
-to be installed on your local system.
+To install, use the Arduino Library Manager and search for "Adafruit BME280" and install the library.
 
-Adafruit invests time and resources providing this open source code, 
+## Dependencies
-please support Adafruit and open-source hardware by purchasing 
+ * [Adafruit Unified Sensor Driver](https://github.com/adafruit/Adafruit_Sensor)
-products from Adafruit!
 
-Check out the links above for our tutorials and wiring diagrams 
+# Contributing
 
-Written by Limor Fried/Ladyada for Adafruit Industries.  
+Contributions are welcome! Please read our [Code of Conduct](https://github.com/adafruit/Adafruit_PM25AQI/blob/master/CODE_OF_CONDUCT.md>)
-BSD license, all text above must be included in any redistribution
+before contributing to help this project stay welcoming.
 
-To download. click the DOWNLOAD ZIP button, rename the uncompressed folder Adafruit_BME280. 
+## Documentation and doxygen
-Check that the Adafruit_BME280 folder contains Adafruit_BME280.cpp and Adafruit_BME280.h
+Documentation is produced by doxygen. Contributions should include documentation for any new code added.
 
-Place the Adafruit_BME280 library folder your arduinosketchfolder/libraries/ folder. 
+Some examples of how to use doxygen can be found in these guide pages:
-You may need to create the libraries subfolder if its your first library. Restart the IDE.
 
-We also have a great tutorial on Arduino library installation at:
+https://learn.adafruit.com/the-well-automated-arduino-library/doxygen
-http://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use
+
+https://learn.adafruit.com/the-well-automated-arduino-library/doxygen-tips
+
+## Formatting and clang-format
+This library uses [`clang-format`](https://releases.llvm.org/download.html) to standardize the formatting of `.cpp` and `.h` files.
+Contributions should be formatted using `clang-format`:
+
+The `-i` flag will make the changes to the file.
+```bash
+clang-format -i *.cpp *.h
+```
+If you prefer to make the changes yourself, running `clang-format` without the `-i` flag will print out a formatted version of the file. You can save this to a file and diff it against the original to see the changes.
+
+Note that the formatting output by `clang-format` is what the automated formatting checker will expect. Any diffs from this formatting will result in a failed build until they are addressed. Using the `-i` flag is highly recommended.
+
+### clang-format resources
+  * [Binary builds and source available on the LLVM downloads page](https://releases.llvm.org/download.html)
+  * [Documentation and IDE integration](https://clang.llvm.org/docs/ClangFormat.html)
+
+## About this Driver
+Written by Ladyada for Adafruit Industries.
+
+BSD license, check license.txt for more information
+
+All text above must be included in any redistribution