Skip to content

Commit

Permalink
Updated doc, fixed spellings
Browse files Browse the repository at this point in the history
  • Loading branch information
RajatMathew authored Oct 31, 2022
1 parent a2c6661 commit 7bc65ae
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 17 deletions.
37 changes: 21 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,46 @@
## About Us
Too many technological developments and innovations occurring at rocket speed! Many of us do not even dare catch up with this, being already convinced that we cannot stay abreast of the current and latest buzz. If at all you do, you find yourself so lost in the sea of knowledge you just stepped in. Here is where Techmyrmidons come to help you get wet without drowning!

Techmyrmidon is a virtual technology icon who keeps itself updated with current technologies, changes its tools to match the trends, follows right experts, and, the best blogs on a particular field of interest. To taste the latest tech trends and rightly pick your associates and mentors in technology, all you need to do is to follow the Techmyrmidon of your area of expertise. Here at Techmyrmidons, you will get to know where you stand and help you keep updated with relevant tools as well as collaborate with interesting and informed people in the domain.
Techmyrmidon is a virtual technology icon who keeps itself updated with current technologies, changes its tools to match the trends, follows the right experts, and, the best blogs on a particular field of interest. To taste the latest tech trends and rightly pick your associates and mentors in technology, all you need to do is to follow the Techmyrmidon of your area of expertise. Here at Techmyrmidons, you will get to know where you stand and help you keep updated with relevant tools as well as collaborate with interesting and informed people in the domain.

At this open source platform, all of us are participants in a sort of giant, crowd-sourced focus group that helps filter and propagate useful technology in our day-to-day routines. Challenge yourself to meet the Techmyrmidons, face their tech weapons, follow their grooming methods and become a Techmyrmidon yourself. You'll be surprised to see what's waiting just around the corner!

## How to Contribute
## How to Contribute

### New Technology
In case you are not familiar with JSON format, you can learn it real quick with these resources:
- [Video] [Learn JSON in 10 minutes](https://www.youtube.com/watch?v=iiADhChRriM&t=2s)
- [Article] [JSON Quick Guide](https://www.tutorialspoint.com/json/json_quick_guide.htm)


### Adding new Technologies
- Fork this repository to your own account.
- Inside the `src/data` there are folders which are named corresponding to the technology for which they contain the data.
- Inside `src/data` , there are folders which are named corresponding to the technology for which they contain the data.
- For Eg. the folder `/src/data/web` has `{year}.json`, `years.json`, `blog.json` and `follow.json`.
- If in the 2025 there is new technology. First you will be creating `2025.json` following the format of the previous years.
- If in the year 2025 there is a new technology. First you will be creating `2025.json` following the format of the previous years.
- Then you will be updating `years.json`
```
{
"year": "2025",
"url": "/data/web/2025.json"
},
```
- To add the new technology update the `{year}.json` with reqired data in the given format.
- To add the new technology, update the `{year}.json` with required data in the given format.
```
{
"2025": [
{
"title": "technology name",
"description":"technology description",
"url": "link to landing of that technology"
"url": "link to the website of that technology"
"morelink": ""
},
]
}
```
### New Blogs
### Adding new blogs
- Fork this repository to your own account.
- Inside the `src/data` there are folders which are named corresponding to the technology for which they contain the data.
- Inside `src/data` , there are folders which are named corresponding to the technology for which they contain the data.
- Inside each folder there are files named `blog.json`
- Update it with all the required informations.
```
Expand All @@ -46,9 +51,9 @@ At this open source platform, all of us are participants in a sort of giant, cro
"author": "blog author"
},
```
### New People
### Adding new people to follow
- Fork this repository to your own account.
- Inside the `src/data` there are folders which are named corresponding to the technology for which they contain the data.
- Inside `src/data` , there are folders which are named corresponding to the technology for which they contain the data.
- Inside each folder there are files named `follow.json`
- Update it with all the required informations.
```
Expand All @@ -58,12 +63,12 @@ At this open source platform, all of us are participants in a sort of giant, cro
"name":"Brad Frost"
},
```
- Do upload the photo of the person in the folder named Images in `/src/data/{technology}/images`
- Do upload the photo of the person in the folder named Images in `/src/data/{technology_name}/images`
### Once Completed
- After you are done, raise a Pull Request to our repository
- If you find any discrepancies in the data, feel free to open an issue. Or even raise an updation PR. It's ideal to have supporting docs, in case you are changing some core information..
- After you are done, raise a Pull Request to the repository.
## Guideilines
## Guidelines
- Try to avoid duplicates.
- Please try to make sure that all the link and images are legit as well as working before raising the pull request.
- Please try to make sure that all the links and images are legit as well as working before raising the pull request.
- If you find any discrepancies in the data, feel free to open an issue, or raise an updation PR. It woudl be great if you have supporting docs, in case you are changing some core information.
2 changes: 1 addition & 1 deletion src/Pages/Landing/Landing.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ const Landing = () => {
/>
<Card
image="/assets/landing/ai.png"
name="Articial Intelligence"
name="Artifcial Intelligence"
link="/ai"
description="AI which stands for artificial intelligence refers to systems or machines that mimic human intelligence to perform tasks."
/>
Expand Down

0 comments on commit 7bc65ae

Please sign in to comment.