Skip to content

Commit e45632b

Browse files
committed
Readme updated
1 parent d0650f6 commit e45632b

File tree

1 file changed

+38
-31
lines changed

1 file changed

+38
-31
lines changed

readme.md

+38-31
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,9 @@
11
# India Dev Stack
22

3-
India Dev Stack is a curated directory of software development tools created by Indian founders. This platform showcases and supports the incredible innovation emerging from Indian developers in the dev tools space.
3+
[India Dev Stack](https://india-dev-stack.com/?utm_source=github) is a curated directory of software development tools created by Indian founders. This platform showcases and supports the incredible innovation emerging from Indian developers in the dev tools space.
44

55
![hero-section](public/opengraph.png)
66

7-
## Table of Contents
8-
9-
- [Features](#features)
10-
- [Technologies Used](#technologies-used)
11-
- [Getting Started](#getting-started)
12-
- [Project Structure](#project-structure)
13-
- [Contributing](#contributing)
14-
157
## Features
168

179
- Curated collection of dev-tools and technologies from India
@@ -21,6 +13,35 @@ India Dev Stack is a curated directory of software development tools created by
2113
- Responsive design for various devices
2214
- Dark mode support
2315

16+
## How to submit your software
17+
18+
We welcome contributions to [India Dev Stack](https://india-dev-stack.com/?utm_source=github)! If you'd like to add a new software tool, please follow these steps:
19+
20+
1. Fork this repository
21+
2. Create a new YAML for your software in `/src/content/software/` with all the details. Ensure that you add right category, tags, description, demo link, top features, etc. The name of the file will be the slug in the URL.
22+
3. Add a logo (`/public/logos`) and thumbnails (`/public/thumbnails`) directory.
23+
4. Submit a pull request
24+
25+
For more details, please refer to our [Contribution Guidelines](CONTRIBUTING.md).
26+
27+
## Submission Criteria
28+
29+
- At least one founder must be Indian or have a substantial presence or development center in India.
30+
- The tool must be dedicated to software development and testing, enhancing any stage of the SDLC, and boosting team productivity and effectiveness.
31+
32+
#### Good Examples:
33+
34+
- IDEs or Code Editors
35+
- Testing tools
36+
- Tools that enhance software development productivity
37+
- Project management tools for software teams
38+
- Tools for measuring software team productivity
39+
40+
#### Bad Examples:
41+
42+
- API products focused solely on integration
43+
- Tools whose ideal customer profiles are not CTOs, Engineering Managers, Developers, or QA personnel
44+
2445
## Technologies Used
2546

2647
- 🔥[Astro](https://astro.build/) - Static Site Generator
@@ -54,30 +75,16 @@ India Dev Stack is a curated directory of software development tools created by
5475

5576
## Project Structure
5677

78+
#### Static Content
79+
5780
- `public`:
81+
- `/public/blog-assets`: Pics for blog posts
82+
- `/public/logos`: Logos of the company
83+
- `/public/thumbnails`: Upload thumbnails for software entries.
5884

59-
- `/public/blog`: Pics for blog posts
60-
- `/public/logos`: Logos of software you add
61-
- `/public/software`: Pics for software entries
85+
#### Dynamic Content
6286

6387
- `src/`:
64-
- `components/`: Reusable UI components
65-
- `content/software/`: Software entries in .yaml format
66-
- `layouts/`: Page layouts
67-
- `pages/`: Astro pages
68-
- `styles/`: Global styles
69-
- `utils/`: Utility functions
70-
71-
## Contributing
72-
73-
We welcome contributions to India Dev Stack! If you'd like to add a new software tool or improve the platform, please follow these steps:
74-
75-
1. Fork the repository
76-
2. Create a new yaml for your software with all the details and add it to the `content/software` directory
77-
3. Add a logo for your software in the `public/logos` directory and add the picture in the `public/software` directory
78-
4. Make your other necessary changes
79-
5. Submit a pull request
80-
81-
For more details, please refer to our [Contribution Guidelines](CONTRIBUTING.md).
88+
- `content/software/`: Software entries in .yaml format. One file, one entry.
89+
- `content/blogs/`: You are invited to write new content for fellow founders.
8290

83-
### Powered by [Beeceptor](https://beeceptor.com/)

0 commit comments

Comments
 (0)