README
¶
Freshops CLI v1.0
What is this?
This is a cli tool that can be run on any codebase of ours to document project metadata at different levels such as
- Technical Fundamentals
- Security Practices
- Reliability
- Maintenance
- Usability
Why should we use this?
- all projects have a baseline reliable and vetted spec to refer to
- improve overall quality of our apps and delivery
- avoid human oversight
- enrich and transmit knowledge easily
- smooth operations
What is the ROI?
- Time - Invest time in discovering and enriching spec instead of revisiting same problems
- Quality - Assured Standard for all projects at set minimum of a spec
- Speed & Clarity - Baseline reference enables bringing projects to speed easily
- Security - Avoid risking project security by LCD philosophy
Documentation
¶
Overview ¶
Copyright © 2020 Vyas Sarangapani vyas@freshworks.io
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.