README Update
Compare changes
+ 21
− 80
Vehicles are becoming more smarter and autonomous with the rapid growth in Automotive technology and Internet of Things (IoT). Internet of Vehicles (IoV) is gaining popularity, alongside the security challenges associated with them are increasing. To address the security issues and to provide accountability and transparency with privacy to the IoV ecosystem, Blockchain technology would best suite to address the challenges posed. In this thesis, a RealTime Blockchain for Internet of Vehicles is proposed based on BigchainDB and Interplanetary File System (IPFS). The entire process from vehicle registration \& its communication with the ecosystem and all the stakeholders are brought on to the blockchain platform. The vehicle log is collected and stored in IPFS and its is monitored by dedicated smart contract services running on the blockchain which takes appropriate actions when conditions are met. The proposed blockchain also has native cryptotokens support that could be used to incentivize good driving behaviours and these tokens could be exchanged at the vehicle service centres, toll booth, fuel refilling stations for payment within the blockchain ecosystem.
[Ramaguru, R.](), [Sindhu, M.](), [Sethumadhavan, M.]() (2019). **Blockchain for the Internet of Vehicles.** In: Singh, M., Gupta, P., Tyagi, V., Flusser, J., Ören, T., Kashyap, R. (eds) _Advances in Computing and Data Sciences. ICACDS 2019._ Communications in Computer and Information Science, vol 1045. Springer, Singapore. [https://doi.org/10.1007/978-981-13-9939-8_37](https://doi.org/10.1007/978-981-13-9939-8_37)
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.